Mercurial > pidgin
changeset 21242:76bdbe79d40f
Document the UI hint defines and remove some bad ui_hint @param lines from
when I copied-and-pasted the documentation back to the old functions.
| author | Richard Laager <rlaager@wiktel.com> |
|---|---|
| date | Sun, 14 Oct 2007 19:50:27 +0000 |
| parents | d8990c20cbee |
| children | 6402252be3c8 b2aab3aa316b |
| files | libpurple/request.h |
| diffstat | 1 files changed, 54 insertions(+), 13 deletions(-) [+] |
line wrap: on
line diff
--- a/libpurple/request.h Sun Oct 14 19:46:19 2007 +0000 +++ b/libpurple/request.h Sun Oct 14 19:50:27 2007 +0000 @@ -198,28 +198,77 @@ } PurpleRequestField; +/* + * UI hints for the request functions. These are used by libpurple. + */ + /** - * List of UI hints used by purple + * @since 2.3.0 */ #define PURPLE_REQUEST_HINT_ACCOUNT "account" + +/** + * @since 2.3.0 + */ #define PURPLE_REQUEST_HINT_BLIST "blist" + +/** + * @since 2.3.0 + */ #define PURPLE_REQUEST_HINT_BUDDY "buddy" + +/** + * @since 2.3.0 + */ #define PURPLE_REQUEST_HINT_CONV "conversation" + +/** + * @since 2.3.0 + */ #define PURPLE_REQUEST_HINT_REGISTER "register-account" -#define PURPLE_REQUEST_HINT_XFER "xfer" /** - * List of UI hints used by purple UIs - * We need a header file included by both pidgin and finch, but not part of - * libpurple for these + * @since 2.3.0 + */ +#define PURPLE_REQUEST_HINT_XFER "xfer" + + +/* + * UI hints for the request functions. These are common hints used by UIs. + * UIs can still define any hints they like, but standardization is good. + */ + +/** + * @since 2.3.0 */ #define PURPLE_UI_REQUEST_HINT_ACCOUNTMGR "accountmgr" + +/** + * @since 2.3.0 + */ #define PURPLE_UI_REQUEST_HINT_CERTMGR "certmgr" + +/** + * @since 2.3.0 + */ #define PURPLE_UI_REQUEST_HINT_PLUGINMGR "pluginmgr" + +/** + * @since 2.3.0 + */ #define PURPLE_UI_REQUEST_HINT_POUNCEMGR "pouncemgr" + +/** + * @since 2.3.0 + */ #define PURPLE_UI_REQUEST_HINT_PREFSMGR "preferences" + +/** + * @since 2.3.0 + */ #define PURPLE_UI_REQUEST_HINT_STATUSMGR "statusmgr" + /** * Request UI operations. */ @@ -1370,7 +1419,6 @@ * @param account The PurpleAccount associated with this request, or NULL if none is * @param who The username of the buddy assocaited with this request, or NULL if none is * @param conv The PurpleConversation associated with this request, or NULL if none is - * @param ui_hint UI hint * @param user_data The data to pass to the callback. * * @return A UI-specific handle. @@ -1439,7 +1487,6 @@ * @param account The PurpleAccount associated with this request, or NULL if none is * @param who The username of the buddy assocaited with this request, or NULL if none is * @param conv The PurpleConversation associated with this request, or NULL if none is - * @param ui_hint UI hint * @param user_data The data to pass to the callback. * @param ... The choices. This argument list should be * terminated with a NULL parameter. @@ -1509,7 +1556,6 @@ * @param account The PurpleAccount associated with this request, or NULL if none is * @param who The username of the buddy assocaited with this request, or NULL if none is * @param conv The PurpleConversation associated with this request, or NULL if none is - * @param ui_hint UI hint * @param user_data The data to pass to the callback. * @param choices The choices. This argument list should be * terminated with a @c NULL parameter. @@ -1579,7 +1625,6 @@ * @param account The PurpleAccount associated with this request, or NULL if none is * @param who The username of the buddy assocaited with this request, or NULL if none is * @param conv The PurpleConversation associated with this request, or NULL if none is - * @param ui_hint UI hint * @param user_data The data to pass to the callback. * @param action_count The number of actions. * @param ... A list of actions. These are pairs of @@ -1648,7 +1693,6 @@ * @param account The PurpleAccount associated with this request, or NULL if none is * @param who The username of the buddy assocaited with this request, or NULL if none is * @param conv The PurpleConversation associated with this request, or NULL if none is - * @param ui_hint UI hint * @param user_data The data to pass to the callback. * @param action_count The number of actions. * @param actions A list of actions and callbacks. @@ -1715,7 +1759,6 @@ * @param account The PurpleAccount associated with this request, or NULL if none is * @param who The username of the buddy associated with this request, or NULL if none is * @param conv The PurpleConversation associated with this request, or NULL if none is - * @param ui_hint UI hint * @param user_data The data to pass to the callback. * * @return A UI-specific handle. @@ -1870,7 +1913,6 @@ * @param account The PurpleAccount associated with this request, or NULL if none is * @param who The username of the buddy assocaited with this request, or NULL if none is * @param conv The PurpleConversation associated with this request, or NULL if none is - * @param ui_hint UI hint * @param user_data The data to pass to the callback. * * @return A UI-specific handle. @@ -1925,7 +1967,6 @@ * @param account The PurpleAccount associated with this request, or NULL if none is * @param who The username of the buddy assocaited with this request, or NULL if none is * @param conv The PurpleConversation associated with this request, or NULL if none is - * @param ui_hint UI hint * @param user_data The data to pass to the callback. * * @return A UI-specific handle.