annotate doc/notify-signals.dox @ 14089:10e8eb6a4910

[gaim-migrate @ 16712] Pretty large commit here. Basically I got sick of having to verify that gc is still valid on all the callback functions for gaim_proxy_connect(). The fix for this for gaim_proxy_connect() to return something that allows the connection attempt to be canceled. It's not quite there yet, but this is a good first step. I changed gaim_proxy_connect() to return a reference to a new GaimProxyConnectInfo (this used to be called PHB). Eventually this can be passed to a function that'll cancel the connection attempt. I also decided to add an error_cb instead of using connect_cb and passing a file descriptor of -1. And proxy.c will also pass an error message to callers which should explain the reason that the connection attempt failed. Oh, and proxy.c now never calls gaim_connection_error() 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