annotate doc/plugin-ids.dox @ 16569:99bf55ec6ca4

Fix an invalid read that occurs because we were accessing IM data when the conversation was a chat. Here's the relevant valgrind output. ==18344== Invalid read of size 4 ==18344== at 0x8089DA1: update_typing_icon (gtkconv.c:3138) ==18344== by 0x8090742: pidgin_conv_update_fields (gtkconv.c:6081) ... ==18344== Address 0x107EADD0 is 12 bytes after a block of size 12 alloc'd ==18344== at 0x40056D5: calloc (vg_replace_malloc.c:279) ==18344== by 0x4D48EC4D: g_malloc0 (in /usr/lib/libglib-2.0.so.0.1200.4) ==18344== by 0x809149B: private_gtkconv_new (gtkconv.c:4608) ==18344== by 0x4056637: purple_conversation_new (conversation.c:324) ==18344== by 0x40785EB: serv_got_joined_chat (server.c:699) ==18344== by 0x493C813: irc_msg_join (msgs.c:722) ...

/** @page plugin-ids Plugin IDs

 @section Introduction
  Every plugin contains a unique identifier to prevent duplicate plugin
  loading and conflicts. This, which will be called a plugin ID from here
  on, must follow a specific format. This format categorizes a plugin and
  makes duplicate IDs unlikely.


 @section Format
  The basic format of a plugin ID is as follows:

  <tt><i>type</i>-<i>username</i>-<i>pluginname</i></tt>

  The @em type indicator specifies the type of plugin. This must be one
  of the following:

    - core      - Core plugin, capable of being loaded in any program using
                  libpurple. It must not use any UI-specific code.
    - prpl      - Protocol plugin, providing additional protocols to
                  connect to.
    - lopl      - Loader plugin, which loads scripts as plugins (like Perl
                  or TCL).
    - gtk       - GTK+ 2.x plugin. It may use GTK+ code, but cannot use any
                  window toolkit code (such as X11 or Win32).
    - gtk-x11   - GTK+ 2.x plugin using X11 code.
    - gtk-win32 - GTK+ 2.x plugin using Win32 code.
    - qpe       - Gaim for Qtopia plugin.

  The @em username must be a unique identifier for that person. It
  @em should be your SourceForge ID. Do @em not leave this field
  blank.

  The @em pluginname is the name of your plugin. It can be whatever you like,
  though it's common to keep it all lowercase. Do not use spaces! If you
  want a space, use a '-'. Please do not put a version indicator in the ID.
  The PurplePlugin structure already has a field for this.


 @section plugin-db Plugin Database
  Although it doesn't exist yet, in time there will be a plugin database
  on the Pidgin website, where users can download and install new plugins.
  Plugins will be accessed by your plugin ID, which is one reason why it
  must be unique. 

 */

// vim: syntax=c tw=75 et