/soc/2013/ankitkv/gobjectification: 5a6336f20f6e: Convert docs f...
Ankit Vani
a at nevitus.org
Sat Feb 1 17:19:51 EST 2014
Changeset: 5a6336f20f6e0d25cff2fff479bfe35faa66ec3f
Author: Ankit Vani <a at nevitus.org>
Date: 2014-02-02 03:49 +0530
Branch: gtkdoc-conversion
URL: https://hg.pidgin.im/soc/2013/ankitkv/gobjectification/rev/5a6336f20f6e
Description:
Convert docs from doxygen to gtk-doc format for finch
diffstat:
finch/gntaccount.h | 13 ++++++++-
finch/gntblist.h | 67 +++++++++++++++++++++++++++++++++++-----------------
finch/gntconn.h | 6 ++++
finch/gntconv.h | 16 +++++++++---
finch/gntdebug.h | 8 ++++++
finch/gntidle.h | 2 +
finch/gntlog.h | 30 +++++++++++++++++------
finch/gntmenuutil.h | 5 ++-
finch/gntnotify.h | 6 ++++
finch/gntpounce.h | 15 ++++++++++-
finch/gntprefs.h | 8 ++++++
finch/gntrequest.h | 14 +++++++++-
finch/gntroomlist.h | 8 ++++++
finch/gntsound.h | 15 ++++++++++-
finch/gntstatus.h | 7 +++-
finch/gntxfer.h | 34 ++++++++++++++++++++------
16 files changed, 200 insertions(+), 54 deletions(-)
diffs (truncated from 808 to 300 lines):
diff --git a/finch/gntaccount.h b/finch/gntaccount.h
--- a/finch/gntaccount.h
+++ b/finch/gntaccount.h
@@ -34,6 +34,8 @@
/*@{*/
/**
+ * finch_accounts_get_ui_ops:
+ *
* Get the ui-functions.
*
* Returns: The PurpleAccountUiOps structure populated with the appropriate functions.
@@ -41,24 +43,31 @@
PurpleAccountUiOps *finch_accounts_get_ui_ops(void);
/**
+ * finch_accounts_init:
+ *
* Perform necessary initializations.
*/
void finch_accounts_init(void);
/**
+ * finch_accounts_uninit:
+ *
* Perform necessary uninitializations.
*/
void finch_accounts_uninit(void);
/**
+ * finch_accounts_show_all:
+ *
* Show the account-manager dialog.
*/
void finch_accounts_show_all(void);
/**
+ * finch_account_dialog_show:
+ * @account: The account to edit, or %NULL to create a new account.
+ *
* Show the edit dialog for an account.
- *
- * @account: The account to edit, or %NULL to create a new account.
*/
void finch_account_dialog_show(PurpleAccount *account);
diff --git a/finch/gntblist.h b/finch/gntblist.h
--- a/finch/gntblist.h
+++ b/finch/gntblist.h
@@ -35,13 +35,17 @@
/*@{*/
/**
+ * FinchBlistManager:
+ * @id: An identifier for the manager.
+ * @name: Displayable name for the manager.
+ *
* Buddylist manager for finch. This decides the visility, ordering and hierarchy
* of the buddylist nodes. This also manages the creation of tooltips.
*/
typedef struct
{
- const char *id; /**< An identifier for the manager. */
- const char *name; /**< Displayable name for the manager. */
+ const char *id;
+ const char *name;
gboolean (*init)(void); /**< Called right before it's being used. */
gboolean (*uninit)(void); /**< Called right after it's not being used any more. */
gboolean (*can_add_node)(PurpleBlistNode *node); /**< Whether a node should be added to the view. */
@@ -53,6 +57,8 @@ typedef struct
} FinchBlistManager;
/**
+ * finch_blist_get_ui_ops:
+ *
* Get the ui-functions.
*
* Returns: The PurpleBlistUiOps structure populated with the appropriate functions.
@@ -60,99 +66,116 @@ typedef struct
PurpleBlistUiOps * finch_blist_get_ui_ops(void);
/**
+ * finch_blist_init:
+ *
* Perform necessary initializations.
*/
void finch_blist_init(void);
/**
+ * finch_blist_uninit:
+ *
* Perform necessary uninitializations.
*/
void finch_blist_uninit(void);
/**
+ * finch_blist_show:
+ *
* Show the buddy list.
*/
void finch_blist_show(void);
/**
+ * finch_blist_get_position:
+ * @x: The x-coordinate is set here if not %NULL.
+ * @y: The y-coordinate is set here if not %NULL.
+ *
* Get the position of the buddy list.
*
- * @x: The x-coordinate is set here if not @ NULL.
- * @y: The y-coordinate is set here if not %NULL.
- *
* Returns: Returns %TRUE if the values were set, %FALSE otherwise.
*/
gboolean finch_blist_get_position(int *x, int *y);
/**
- * Set the position of the buddy list.
- *
+ * finch_blist_set_position:
* @x: The x-coordinate of the buddy list.
* @y: The y-coordinate of the buddy list.
+ *
+ * Set the position of the buddy list.
*/
void finch_blist_set_position(int x, int y);
/**
+ * finch_blist_get_size:
+ * @width: The width is set here if not %NULL.
+ * @height: The height is set here if not %NULL.
+ *
* Get the size of the buddy list.
*
- * @width: The width is set here if not @ NULL.
- * @height: The height is set here if not %NULL.
- *
* Returns: Returns %TRUE if the values were set, %FALSE otherwise.
*/
gboolean finch_blist_get_size(int *width, int *height);
/**
- * Set the size of the buddy list.
- *
+ * finch_blist_set_size:
* @width: The width of the buddy list.
* @height: The height of the buddy list.
+ *
+ * Set the size of the buddy list.
*/
void finch_blist_set_size(int width, int height);
/**
- * Get information about a user. Show immediate feedback.
- *
+ * finch_retrieve_user_info:
* @conn: The connection to get information fro
* @name: The user to get information about.
*
+ * Get information about a user. Show immediate feedback.
+ *
* Returns: Returns the ui-handle for the userinfo notification.
*/
gpointer finch_retrieve_user_info(PurpleConnection *conn, const char *name);
/**
+ * finch_blist_get_tree:
+ *
* Get the tree list of the buddy list.
* Returns: The GntTree widget.
*/
GntTree * finch_blist_get_tree(void);
/**
+ * finch_blist_install_manager:
+ * @manager: The alternate buddylist manager.
+ *
* Add an alternate buddy list manager.
- *
- * @manager: The alternate buddylist manager.
*/
void finch_blist_install_manager(const FinchBlistManager *manager);
/**
+ * finch_blist_uninstall_manager:
+ * @manager: The buddy list manager to remove.
+ *
* Remove an alternate buddy list manager.
- *
- * @manager: The buddy list manager to remove.
*/
void finch_blist_uninstall_manager(const FinchBlistManager *manager);
/**
+ * finch_blist_manager_find:
+ * @id: The identifier for the desired buddy list manager.
+ *
* Find a buddy list manager.
*
- * @id: The identifier for the desired buddy list manager.
- *
* Returns: The manager with the requested identifier, if available. %NULL otherwise.
*/
FinchBlistManager * finch_blist_manager_find(const char *id);
/**
+ * finch_blist_manager_add_node:
+ * @node: The node to add
+ *
* Request the active buddy list manager to add a node.
- *
- * @node: The node to add
*/
void finch_blist_manager_add_node(PurpleBlistNode *node);
diff --git a/finch/gntconn.h b/finch/gntconn.h
--- a/finch/gntconn.h
+++ b/finch/gntconn.h
@@ -34,6 +34,8 @@
/*@{*/
/**
+ * finch_connections_get_ui_ops:
+ *
* Get the ui-functions.
*
* Returns: The PurpleConnectionUiOps structure populated with the appropriate functions.
@@ -41,11 +43,15 @@
PurpleConnectionUiOps *finch_connections_get_ui_ops(void);
/**
+ * finch_connections_init:
+ *
* Perform necessary initializations.
*/
void finch_connections_init(void);
/**
+ * finch_connections_uninit:
+ *
* Perform necessary uninitializations.
*/
void finch_connections_uninit(void);
diff --git a/finch/gntconv.h b/finch/gntconv.h
--- a/finch/gntconv.h
+++ b/finch/gntconv.h
@@ -83,6 +83,8 @@ struct _FinchConvIm
};
/**
+ * finch_conv_get_ui_ops:
+ *
* Get the ui-functions.
*
* Returns: The PurpleConversationUiOps populated with the appropriate functions.
@@ -90,28 +92,34 @@ struct _FinchConvIm
PurpleConversationUiOps *finch_conv_get_ui_ops(void);
/**
+ * finch_conversation_init:
+ *
* Perform the necessary initializations.
*/
void finch_conversation_init(void);
/**
+ * finch_conversation_uninit:
+ *
* Perform the necessary uninitializations.
*/
void finch_conversation_uninit(void);
/**
+ * finch_conversation_set_active:
+ * @conv: The conversation to make active.
+ *
* Set a conversation as active in a contactized conversation
- *
- * @conv: The conversation to make active.
*/
void finch_conversation_set_active(PurpleConversation *conv);
/**
- * Sets the information widget for the conversation window.
- *
+ * finch_conversation_set_info_widget:
* @conv: The conversation.
* @widget: The widget containing the information. If %NULL,
* the current information widget is removed.
+ *
+ * Sets the information widget for the conversation window.
*/
void finch_conversation_set_info_widget(PurpleConversation *conv, GntWidget *widget);
diff --git a/finch/gntdebug.h b/finch/gntdebug.h
--- a/finch/gntdebug.h
+++ b/finch/gntdebug.h
@@ -34,6 +34,8 @@
/*@{*/
More information about the Commits
mailing list