view doc/cipher-signals.dox @ 22119:392bfb84d372

Clarify documentation of purple_account_set_status_list(), and use @copydoc to make purple_account_set_status() have the exact same text (prefixed with a remark about being a vargs version of the former). Do people like this? We have duplicated docs all over the place with vargs and GList/va_list versions of functions, and it seems like we should either use @copydoc for one, or make its doc just read "version of foo_list(), see it for documentation". (Why -do- we have two versions of everything?)
author Will Thompson <will.thompson@collabora.co.uk>
date Tue, 15 Jan 2008 19:33:20 +0000
parents e0613cf8c493
children
line wrap: on
line source

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