annotate doc/notify-signals.dox @ 13753:c066473fff04

[gaim-migrate @ 16164] SF Patch #1482906 from Sadrul "The timestamp plugin was not working. This makes it work again. Looks like I didn't update this one when the displaying- signals were moved to gtkconv from conv. Also, I think having this timestamp work for chat windows can't hurt. So I have added support for that too." If you object to the change in functionality, that's easy to remove. I wasn't sure, since I don't use this plugin, but I kept it because I can't think of a reason you wouldn't want the timestamps in chats as well. committer: Tailor Script <[e-mail]>

/** @page conversation-signals Notification Signals

 @signals
  @signal displaying-userinfo
 @endsignals

 @signaldef displaying-userinfo
  @signalproto
void (*displaying_userinfo)(GaimAccount *account, const char *who, char **infotext);
  @endsignalproto
  @signaldesc
   Emitted before userinfo is handed to the UI to display.
   @a infotext is a pointer to a string, so a plugin can replace the text that
   will be displayed.
  @note
   Make sure to free @a *infotext before you replace it!
  @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 infotext A pointer to the userinfo text to be displayed.
 @endsignaldef

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