# HG changeset patch
# User Evan Schoenberg <evan.s@dreskin.net>
# Date 1167101233 0
# Node ID faa6afdcea39c9d05fcd4b3ef8dd3f90da3b8bf8
# Parent  0a41469d6440de02cf5d279f47b09a07b84c120c
[gaim-migrate @ 18055]
doxygen documentation update for the displaying-userinfo signal

committer: Tailor Script <tailor@pidgin.im>

diff -r 0a41469d6440 -r faa6afdcea39 doc/notify-signals.dox
--- a/doc/notify-signals.dox	Tue Dec 26 02:44:15 2006 +0000
+++ b/doc/notify-signals.dox	Tue Dec 26 02:47:13 2006 +0000
@@ -6,17 +6,16 @@
 
  @signaldef displaying-userinfo
   @signalproto
-void (*displaying_userinfo)(GaimAccount *account, const char *who, char **infotext);
+void (*displaying_userinfo)(GaimAccount *account, const char *who, GaimNotifyUserInfo *user_info);
   @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.
+   @a user_info can be manipulated via the GaimNotifyUserInfo API in notify.c.
   @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.
+    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
 
 */