Mercurial > pidgin.yaz
view doc/gtkblist-signals.dox @ 22119:392bfb84d372
Clarify documentation of purple_account_set_status_list(), and use @copydoc to
make purple_account_set_status() have the exact same text (prefixed with a
remark about being a vargs version of the former).
Do people like this? We have duplicated docs all over the place with vargs and
GList/va_list versions of functions, and it seems like we should either use
@copydoc for one, or make its doc just read "version of foo_list(), see it for
documentation".
(Why -do- we have two versions of everything?)
author | Will Thompson <will.thompson@collabora.co.uk> |
---|---|
date | Tue, 15 Jan 2008 19:33:20 +0000 |
parents | e0613cf8c493 |
children | d75813811637 |
line wrap: on
line source
/** @page gtkblist-signals GtkBlist Signals @signals @signal gtkblist-hiding @signal gtkblist-unhiding @signal gtkblist-created @signal drawing-tooltip @endsignals @see gtkblist.h <hr> @signaldef gtkblist-hiding @signalproto void (*gtkblist-hiding)(PurpleBuddyList *blist); @endsignalproto @signaldesc Emitted when the buddy list is about to be hidden. @param blist The buddy list. @endsignaldef @signaldef gtkblist-unhiding @signalproto void (*gtkblist-unhiding)(PurpleBuddyList *blist); @endsignalproto @signaldesc Emitted when the buddy list is about to be unhidden. @param blist The buddy list. @endsignaldef @signaldef gtkblist-created @signalproto void (*gtkblist-created)(PurpleBuddyList *blist); @endsignalproto @signaldesc Emitted when the buddy list is created. @param blist The buddy list. @endsignaldef @signaldef drawing-tooltip @signalproto void (*drawing-tooltip)(PurpleBlistNode *node, GString *text, gboolean full); @endsignalproto @signaldesc Emitted just before a tooltip is displayed. @a text is a standard GString, so the plugin can modify the text that will be displayed. @note Make sure to free @a *text before you replace it! @param node The blist node for the tooltip. @param text A pointer to the text that will be displayed. @param full Whether we're doing a full tooltip for the priority buddy or a compact tooltip for a non-priority buddy. @endsignaldef */ // vim: syntax=c.doxygen tw=75 et