doc/cipher-signals.dox

Mon, 08 Jun 2009 02:24:49 +0000

author
Elliott Sales de Andrade <qulogic@pidgin.im>
date
Mon, 08 Jun 2009 02:24:49 +0000
changeset 27314
402d25ce01da
parent 20897
2608e9e07913
permissions
-rw-r--r--

Use the JID for adding a chat/buddy because the name is for descriptive
purpose only, and using it will not fill in the Add Chat dialog correctly.
Because the JID is not visible, the user will not know what to actually put
there instead.

/** @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

mercurial