diff doc/notify-signals.dox @ 12129:216988c717da

[gaim-migrate @ 14429] SF Patch #1353745 from bsponline (Ka-Hing Cheung) "Adds a signal to fire an event before userinfo/profile is shown, so that a plugin can modify it." I renamed it from receiving-userinfo to displaying-userinfo and documented it. committer: Tailor Script <[e-mail]>

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/notify-signals.dox	Fri Nov 18 12:44:07 2005 +0000
@@ -0,0 +1,23 @@
+/** @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