annotate doc/cipher-signals.dox @ 29424:2c95b7c57ebb

Fix up the X-Status code in many ways: * Clean up the descriptions to be consistently of the form, "I am _____." * Properly mark the descriptions for translation. * Utilize the files from small smiley theme as much as possible. Through a Makefile rule, they will be copied from emotes/small/16/ to emblems/16 at build time and then installed as usual. This is slightly hackish, but ensures that our icons are consistent and saves manual copying work and duplication of source files in the repository. + As part of this, mobile.png was moved to emotes/small/16, as it is needed in both places. * Call these things "Custom Status Icon"s (adding "Status") in the UI. * Add icqmood0 = shopping, based on testing with ICQ6. Thanks John!!! * Change the xstatus_crap icon to xstatus_typing to match ICQ 6. The other typing icon was left alone, except that the name was set to NULL so we wouldn't get duplicates in the list. * Change the xstatus_iron (Pro7 TV icon) to xstatus_suit, using the 'person wearing a suit' icon from N3fr0n to match ICQ6. I named this icon, somewhat arbitrarily, "At the office". * The PDA icon is now the same as the hiptop, but hopefully that won't cause any confusion. Also, the custom icon is now higher priority than the hiptop icon. * The music icon is the ("tune") emblem, not the emoticon. This seems more consistent, given that we're talking about buddy list emblems. * The "Googling" icon has been renamed to "Searching the web" to avoid the trademark. * The "zzz" icon is now an icon for smoking, which seems to fit with the official client's icon as posted in #4508. Other clients may show a marijuana leaf. Oh well.

/** @page cipher-signals Cipher Signals

 @signals
  @signal cipher-added
  @signal cipher-removed
 @endsignals

 @see cipher.h

 <hr>

 @signaldef cipher-added
  @signalproto
void (*cipher_added)(PurpleCipher *cipher);
  @endsignalproto
  @signaldesc
   Emitted when a cipher is added.
  @param cipher The cipher that was added.
 @endsignaldef

 @signaldef cipher-removed
  @signalproto
void (*cipher_removed)(PurpleCipher *cipher);
  @endsignalproto
  @signaldesc
   Emitted when a cipher is removed.
  @param cipher The cipher that was removed.
 @endsignaldef

 */
// vim: syntax=c.doxygen tw=75 et