annotate doc/notify-signals.dox @ 16086:c7d13e1b07dc

Bleeter thought it might be a good idea to actually put libpurple in the libpurple RPM. Whoops.

/** @page conversation-signals Notification Signals

 @signals
  @signal displaying-userinfo
 @endsignals

 @signaldef displaying-userinfo
  @signalproto
void (*displaying_userinfo)(GaimAccount *account, const char *who, GaimNotifyUserInfo *user_info);
  @endsignalproto
  @signaldesc
   Emitted before userinfo is handed to the UI to display.
   @a user_info can be manipulated via the GaimNotifyUserInfo API in notify.c.
  @note
    If adding a GaimNotifyUserInfoEntry, be sure not to free it -- GaimNotifyUserInfo assumes responsibility for its objects.
  @param account   The account on which the info was obtained.
  @param who       The screen name of the user whose info is to be displayed.
  @param user_info The information to be displayed, as GaimNotifyUserInfoEntry objects
 @endsignaldef

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