im.pidgin.pidgin.next.minor: d0c23dfc8d64e57036509dd2e2248caaea3e6d9f

[rlaager at pidgin.im]

-----------------------------------------------------------------
Revision: d0c23dfc8d64e57036509dd2e2248caaea3e6d9f
Ancestor: 72e9052f6df6e0b426cb94a1e5f949a98b89e49b
Author: rlaager at pidgin.im
Date: 2007-10-14T19:50:27
Branch: im.pidgin.pidgin.next.minor

Modified files:
        libpurple/request.h

ChangeLog: 

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.

-------------- next part --------------
============================================================
--- libpurple/request.h	665d3933cea187f5f3c54d538bfe4dc485d113c9
+++ libpurple/request.h	c532cb5b3c1af07dabce1568e8c7025d29097501
@@ -198,28 +198,77 @@ typedef struct
 
 } 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"
+
+/**
+ * @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.
+ */
+
 /**
- * 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_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 @@ void *purple_request_input_with_hint(voi
  * @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 @@ void *purple_request_choice_with_hint(vo
  * @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 @@ void *purple_request_choice_varg_with_hi
  * @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 @@ void *purple_request_action_with_hint(vo
  * @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 @@ void *purple_request_action_varg_with_hi
  * @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 @@ void *purple_request_fields_with_hint(vo
  * @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 @@ void *purple_request_file_with_hint(void
  * @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 @@ void *purple_request_folder_with_hint(vo
  * @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.