view doc/certificate-signals.dox @ 32635:63e7d226b760

Re-arrange these doxygen comments. For comments longer than a few words, putting the comment before the variable like this seems cleaner than trying to cram it on the same line as the variable and using lots of crazy indentation. Anyone have a strong opinion either way?
author Mark Doliner <mark@kingant.net>
date Sun, 18 Sep 2011 20:18:33 +0000
parents e0613cf8c493
children
line wrap: on
line source

/** @page certificate-signals Certificate Signals

 @signals
  @signal certificate-stored
  @signal certificate-deleted
 @endsignals

 @see certificate.h

 <hr>

 @signaldef certificate-stored
  @signalproto
void (*certificate_stored)(PurpleCertificatePool *pool, const gchar *id, gpointer data);
  @endsignalproto
  @signaldesc
   Emitted when a pool stores a certificate. Connect to the pool instance.
  @param pool    Pool the certificate has been stored into
  @param id      Key the certificate was stored under
 @endsignaldef

 @signaldef certificate-deleted
  @signalproto
void (*certificate_deleted)(PurpleCertificatePool *pool, const gchar *id, gpointer data);
  @endsignalproto
  @signaldesc
   Emitted when a pool deletes a certificate. Connect to the pool instance.
  @param pool    Pool the certificate was deleted from
  @param id      Key that was deleted
 @endsignaldef

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