/soc/2013/ankitkv/gobjectification: a22531410e3f: Convert docs f...

Ankit Vani a at nevitus.org
Fri Jan 31 14:29:05 EST 2014


Changeset: a22531410e3fc54d5732284c199d453c9e339e15
Author:	 Ankit Vani <a at nevitus.org>
Date:	 2014-02-01 00:57 +0530
Branch:	 gtkdoc-conversion
URL: https://hg.pidgin.im/soc/2013/ankitkv/gobjectification/rev/a22531410e3f

Description:

Convert docs from doxygen to gtk-doc format for request.h and util.h

diffstat:

 libpurple/request.h |  942 +++++++++++++++++++++++++++++++--------------------
 libpurple/util.h    |  674 ++++++++++++++++++++++--------------
 2 files changed, 979 insertions(+), 637 deletions(-)

diffs (truncated from 4150 to 300 lines):

diff --git a/libpurple/request.h b/libpurple/request.h
--- a/libpurple/request.h
+++ b/libpurple/request.h
@@ -31,24 +31,33 @@
 #include <glib.h>
 
 #include "certificate.h"
+#include "conversation.h"
 #include "request-datasheet.h"
 
 /**
+ * PurpleRequestField:
+ *
  * A request field.
  */
 typedef struct _PurpleRequestField PurpleRequestField;
 
 /**
+ * PurpleRequestFields:
+ *
  * Multiple fields request data.
  */
 typedef struct _PurpleRequestFields PurpleRequestFields;
 
 /**
+ * PurpleRequestFieldGroup:
+ *
  * A group of fields with a title.
  */
 typedef struct _PurpleRequestFieldGroup PurpleRequestFieldGroup;
 
 /**
+ * PurpleRequestCommonParameters:
+ *
  * Common parameters for UI operations.
  */
 typedef struct _PurpleRequestCommonParameters PurpleRequestCommonParameters;
@@ -58,21 +67,32 @@ typedef struct _PurpleRequestCommonParam
 #define PURPLE_DEFAULT_ACTION_NONE	-1
 
 /**
+ * PurpleRequestType:
+ * @PURPLE_REQUEST_INPUT:  Text input request.
+ * @PURPLE_REQUEST_CHOICE: Multiple-choice request.
+ * @PURPLE_REQUEST_ACTION: Action request.
+ * @PURPLE_REQUEST_WAIT:   Please wait dialog.
+ * @PURPLE_REQUEST_FIELDS: Multiple fields request.
+ * @PURPLE_REQUEST_FILE:   File open or save request.
+ * @PURPLE_REQUEST_FOLDER: Folder selection request.
+ *
  * Request types.
  */
 typedef enum
 {
-	PURPLE_REQUEST_INPUT = 0,  /**< Text input request.        */
-	PURPLE_REQUEST_CHOICE,     /**< Multiple-choice request.   */
-	PURPLE_REQUEST_ACTION,     /**< Action request.            */
-	PURPLE_REQUEST_WAIT,       /**< Please wait dialog.        */
-	PURPLE_REQUEST_FIELDS,     /**< Multiple fields request.   */
-	PURPLE_REQUEST_FILE,       /**< File open or save request. */
-	PURPLE_REQUEST_FOLDER      /**< Folder selection request.  */
+	PURPLE_REQUEST_INPUT = 0,
+	PURPLE_REQUEST_CHOICE,
+	PURPLE_REQUEST_ACTION,
+	PURPLE_REQUEST_WAIT,
+	PURPLE_REQUEST_FIELDS,
+	PURPLE_REQUEST_FILE,
+	PURPLE_REQUEST_FOLDER
 
 } PurpleRequestType;
 
 /**
+ * PurpleRequestFieldType:
+ *
  * A type of field.
  */
 typedef enum
@@ -110,6 +130,8 @@ typedef enum
 typedef void (*PurpleRequestCancelCb)(gpointer);
 
 /**
+ * PurpleRequestUiOps:
+ *
  * Request UI operations.
  */
 typedef struct
@@ -183,11 +205,15 @@ typedef gboolean (*PurpleRequestFieldVal
 
 typedef gboolean (*PurpleRequestFieldSensitivityCb)(PurpleRequestField *field);
 
-/** The type of callbacks passed to purple_request_action().  The first
- *  argument is the @a user_data parameter; the second is the index in the list
- *  of actions of the one chosen.
+/**
+ * PurpleRequestActionCb:
+ *
+ * The type of callbacks passed to purple_request_action().  The first
+ * argument is the <tt>user_data</tt> parameter; the second is the index in the
+ * list of actions of the one chosen.
  */
 typedef void (*PurpleRequestActionCb)(void *, int);
+
 typedef void (*PurpleRequestChoiceCb)(void *, gpointer);
 typedef void (*PurpleRequestFieldsCb)(void *, PurpleRequestFields *fields);
 typedef void (*PurpleRequestFileCb)(void *, const char *filename);
@@ -201,6 +227,8 @@ G_BEGIN_DECLS
 /*@{*/
 
 /**
+ * purple_request_cpar_new:
+ *
  * Creates new parameters set for the request, which may or may not be used by
  * the UI to display the request.
  *
@@ -210,6 +238,8 @@ PurpleRequestCommonParameters *
 purple_request_cpar_new(void);
 
 /**
+ * purple_request_cpar_from_connection:
+ *
  * Creates new parameters set initially bound with the #PurpleConnection.
  *
  * Returns: The new parameters set.
@@ -218,6 +248,8 @@ PurpleRequestCommonParameters *
 purple_request_cpar_from_connection(PurpleConnection *gc);
 
 /**
+ * purple_request_cpar_from_account:
+ *
  * Creates new parameters set initially bound with the #PurpleAccount.
  *
  * Returns: The new parameters set.
@@ -226,6 +258,8 @@ PurpleRequestCommonParameters *
 purple_request_cpar_from_account(PurpleAccount *account);
 
 /**
+ * purple_request_cpar_from_conversation:
+ *
  * Creates new parameters set initially bound with the #PurpleConversation.
  *
  * Returns: The new parameters set.
@@ -233,105 +267,115 @@ purple_request_cpar_from_account(PurpleA
 PurpleRequestCommonParameters *
 purple_request_cpar_from_conversation(PurpleConversation *conv);
 
-/*
+/**
+ * purple_request_cpar_ref:
+ * @cpar: The object to ref.
+ *
  * Increases the reference count on the parameters set.
- *
- * @cpar: The object to ref.
  */
 void
 purple_request_cpar_ref(PurpleRequestCommonParameters *cpar);
 
 /**
+ * purple_request_cpar_unref:
+ * @cpar: The parameters set object to unref and possibly destroy.
+ *
  * Decreases the reference count on the parameters set.
  *
  * The object will be destroyed when this reaches 0.
  *
- * @cpar: The parameters set object to unref and possibly destroy.
- *
  * Returns: The NULL, if object was destroyed, cpar otherwise.
  */
 PurpleRequestCommonParameters *
 purple_request_cpar_unref(PurpleRequestCommonParameters *cpar);
 
 /**
- * Sets the #PurpleAccount associated with the request, or %NULL, if none is.
- *
+ * purple_request_cpar_set_account:
  * @cpar:    The parameters set.
  * @account: The #PurpleAccount to associate.
+ *
+ * Sets the #PurpleAccount associated with the request, or %NULL, if none is.
  */
 void
 purple_request_cpar_set_account(PurpleRequestCommonParameters *cpar,
 	PurpleAccount *account);
 
 /**
+ * purple_request_cpar_get_account:
+ * @cpar: The parameters set (may be %NULL).
+ *
  * Gets the #PurpleAccount associated with the request.
  *
- * @cpar: The parameters set (may be %NULL).
- *
  * Returns: The associated #PurpleAccount, or NULL if none is.
  */
 PurpleAccount *
 purple_request_cpar_get_account(PurpleRequestCommonParameters *cpar);
 
 /**
+ * purple_request_cpar_set_conversation:
+ * @cpar: The parameters set.
+ * @conv: The #PurpleConversation to associate.
+ *
  * Sets the #PurpleConversation associated with the request, or %NULL, if
  * none is.
- *
- * @cpar: The parameters set.
- * @conv: The #PurpleConversation to associate.
  */
 void
 purple_request_cpar_set_conversation(PurpleRequestCommonParameters *cpar,
 	PurpleConversation *conv);
 
 /**
+ * purple_request_cpar_get_conversation:
+ * @cpar: The parameters set (may be %NULL).
+ *
  * Gets the #PurpleConversation associated with the request.
  *
- * @cpar: The parameters set (may be %NULL).
- *
  * Returns: The associated #PurpleConversation, or NULL if none is.
  */
 PurpleConversation *
 purple_request_cpar_get_conversation(PurpleRequestCommonParameters *cpar);
 
 /**
- * Sets the icon associated with the request.
- *
+ * purple_request_cpar_set_icon:
  * @cpar:      The parameters set.
  * @icon_type: The icon type.
+ *
+ * Sets the icon associated with the request.
  */
 void
 purple_request_cpar_set_icon(PurpleRequestCommonParameters *cpar,
 	PurpleRequestIconType icon_type);
 
 /**
+ * purple_request_cpar_get_icon:
+ * @cpar: The parameters set.
+ *
  * Gets the icon associated with the request.
  *
- * @cpar: The parameters set.
- *
  * Returns: icon_type The icon type.
  */
 PurpleRequestIconType
 purple_request_cpar_get_icon(PurpleRequestCommonParameters *cpar);
 
 /**
- * Sets the custom icon associated with the request.
- *
+ * purple_request_cpar_set_custom_icon:
  * @cpar:      The parameters set.
  * @icon_data: The icon image contents (%NULL to reset).
  * @icon_size: The icon image size.
+ *
+ * Sets the custom icon associated with the request.
  */
 void
 purple_request_cpar_set_custom_icon(PurpleRequestCommonParameters *cpar,
 	gconstpointer icon_data, gsize icon_size);
 
 /**
- * Gets the custom icon associated with the request.
- *
+ * purple_request_cpar_get_custom_icon:
  * @cpar:      The parameters set (may be %NULL).
  * @icon_size: The pointer to variable, where icon size should be stored
  *                  (may be %NULL).
  *
+ * Gets the custom icon associated with the request.
+ *
  * Returns: The icon image contents.
  */
 gconstpointer
@@ -339,65 +383,71 @@ purple_request_cpar_get_custom_icon(Purp
 	gsize *icon_size);
 
 /**
- * Switches the request text to be HTML or not.
- *
+ * purple_request_cpar_set_html:
  * @cpar:    The parameters set.
  * @enabled: 1, if the text passed with the request contains HTML,
  *                0 otherwise. Don't use any other values, as they may be
  *                redefined in the future.
+ *
+ * Switches the request text to be HTML or not.
  */
 void
 purple_request_cpar_set_html(PurpleRequestCommonParameters *cpar,
 	gboolean enabled);
 
 /**
+ * purple_request_cpar_is_html:
+ * @cpar: The parameters set (may be %NULL).



More information about the Commits mailing list