view doc/core-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 4179ab2cfe1f
children
line wrap: on
line source

/** @page core-signals Core Signals

 @signals
  @signal quitting
  @signal uri-handler
 @endsignals

 @see core.h

 <hr>

 @signaldef quitting
  @signalproto
void (*quitting)();
  @endsignalproto
  @signaldesc
   Emitted when libpurple is quitting.
 @endsignaldef

 @signaldef uri-handler
  @signalproto
gboolean (*uri_handler)(const gchar *proto, const gchar *cmd, GHashTable *params);
  @endsignalproto
  @signaldesc
   Emitted when handling a registered URI.
  @param proto The protocol of the URI.
  @param cmd The 'command' of the URI.
  @param params Any key/value parameters from the URI.
 @endsignaldef

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