/soc/2013/ankitkv/gobjectification: 00f876b129bc: Initial replac...
Ankit Vani
a at nevitus.org
Fri Jan 31 07:45:02 EST 2014
Changeset: 00f876b129bcb5cf63b98465a7f7707304609058
Author: Ankit Vani <a at nevitus.org>
Date: 2014-01-31 18:14 +0530
Branch: gtkdoc-conversion
URL: https://hg.pidgin.im/soc/2013/ankitkv/gobjectification/rev/00f876b129bc
Description:
Initial replacements for gtk-doc style comments
diffstat:
finch/gntaccount.h | 4 +-
finch/gntblist.h | 40 +-
finch/gntconn.h | 2 +-
finch/gntconv.h | 8 +-
finch/gntdebug.h | 2 +-
finch/gntidle.h | 2 +-
finch/gntlog.h | 2 +-
finch/gntmenuutil.h | 6 +-
finch/gntnotify.h | 2 +-
finch/gntpounce.h | 8 +-
finch/gntrequest.h | 6 +-
finch/gntroomlist.h | 2 +-
finch/gntsound.h | 10 +-
finch/gntstatus.h | 2 +-
finch/gntxfer.h | 14 +-
finch/libgnt/gnt-skel.h | 4 +-
finch/libgnt/gnt.h | 62 +-
finch/libgnt/gntbindable.h | 46 +-
finch/libgnt/gntbox.h | 52 +-
finch/libgnt/gntbutton.h | 6 +-
finch/libgnt/gntcheckbox.h | 14 +-
finch/libgnt/gntclipboard.h | 10 +-
finch/libgnt/gntcolors.h | 18 +-
finch/libgnt/gntcombobox.h | 24 +-
finch/libgnt/gntentry.h | 52 +-
finch/libgnt/gntfilesel.h | 56 +-
finch/libgnt/gntkeys.h | 18 +-
finch/libgnt/gntlabel.h | 16 +-
finch/libgnt/gntline.h | 6 +-
finch/libgnt/gntmenu.h | 16 +-
finch/libgnt/gntmenuitem.h | 40 +-
finch/libgnt/gntmenuitemcheck.h | 14 +-
finch/libgnt/gntprogressbar.h | 28 +-
finch/libgnt/gntslider.h | 44 +-
finch/libgnt/gntstyle.h | 44 +-
finch/libgnt/gnttextview.h | 64 +-
finch/libgnt/gnttree.h | 262 ++++++------
finch/libgnt/gntutils.h | 74 +-
finch/libgnt/gntwidget.h | 90 ++--
finch/libgnt/gntwindow.h | 28 +-
finch/libgnt/gntwm.h | 88 ++--
finch/libgnt/gntws.h | 42 +-
libpurple/account.h | 514 +++++++++++-----------
libpurple/accountopt.h | 142 +++---
libpurple/accounts.h | 28 +-
libpurple/blistnode.h | 128 ++--
libpurple/blistnodetypes.h | 174 ++++----
libpurple/buddyicon.h | 122 ++--
libpurple/buddylist.h | 114 ++--
libpurple/certificate.h | 244 +++++-----
libpurple/cipher.h | 120 ++--
libpurple/circularbuffer.h | 38 +-
libpurple/cmds.h | 50 +-
libpurple/connection.h | 100 ++--
libpurple/conversation.h | 224 +++++-----
libpurple/conversations.h | 40 +-
libpurple/conversationtypes.h | 236 +++++-----
libpurple/core.h | 18 +-
libpurple/dbus-server.h | 20 +-
libpurple/debug.h | 44 +-
libpurple/desktopitem.h | 20 +-
libpurple/dnsquery.h | 26 +-
libpurple/dnssrv.h | 52 +-
libpurple/e2ee.h | 60 +-
libpurple/eventloop.h | 76 +-
libpurple/http.h | 326 +++++++-------
libpurple/idle.h | 4 +-
libpurple/imgstore.h | 54 +-
libpurple/internal.h | 56 +-
libpurple/keyring.h | 158 +++---
libpurple/log.h | 166 +++---
libpurple/media-gst.h | 40 +-
libpurple/media.h | 194 ++++----
libpurple/media/backend-fs2.h | 2 +-
libpurple/media/backend-iface.h | 76 +-
libpurple/media/candidate.h | 74 +-
libpurple/media/codec.h | 64 +-
libpurple/media/enum-types.h | 12 +-
libpurple/mediamanager.h | 82 +-
libpurple/mime.h | 64 +-
libpurple/nat-pmp.h | 16 +-
libpurple/network.h | 78 +-
libpurple/notify.h | 240 +++++-----
libpurple/ntlm.h | 26 +-
libpurple/plugin.h | 158 +++---
libpurple/pluginpref.h | 100 ++--
libpurple/pounce.h | 134 +++---
libpurple/prefs.h | 122 ++--
libpurple/presence.h | 90 ++--
libpurple/proxy.h | 100 ++--
libpurple/prpl.h | 250 +++++-----
libpurple/purple-socket.h | 76 +-
libpurple/request-datasheet.h | 126 ++--
libpurple/request.h | 868 ++++++++++++++++++++--------------------
libpurple/roomlist.h | 124 ++--
libpurple/savedstatuses.h | 114 ++--
libpurple/server.h | 66 +-
libpurple/signals.h | 116 ++--
libpurple/smiley.h | 64 +-
libpurple/sound-theme.h | 18 +-
libpurple/sound.h | 14 +-
libpurple/sslconn.h | 106 ++--
libpurple/status.h | 220 +++++-----
libpurple/stringref.h | 34 +-
libpurple/stun.h | 4 +-
libpurple/theme-loader.h | 16 +-
libpurple/theme-manager.h | 20 +-
libpurple/theme.h | 48 +-
libpurple/upnp.h | 30 +-
libpurple/util.h | 580 +++++++++++++-------------
libpurple/version.h.in | 8 +-
libpurple/whiteboard.h | 130 ++--
libpurple/xfer.h | 316 +++++++-------
libpurple/xmlnode.h | 160 +++---
pidgin/gtkaccount.h | 8 +-
pidgin/gtkblist-theme.h | 156 +++---
pidgin/gtkblist.h | 66 +-
pidgin/gtkconn.h | 4 +-
pidgin/gtkconv-theme.h | 50 +-
pidgin/gtkconv.h | 48 +-
pidgin/gtkdebug.h | 4 +-
pidgin/gtkdnd-hints.h | 16 +-
pidgin/gtkeventloop.h | 2 +-
pidgin/gtkicon-theme.h | 12 +-
pidgin/gtkidle.h | 2 +-
pidgin/gtkimhtml.h | 298 ++++++------
pidgin/gtklog.h | 2 +-
pidgin/gtkmenutray.h | 26 +-
pidgin/gtknotify.h | 18 +-
pidgin/gtkpluginpref.h | 4 +-
pidgin/gtkpounce.h | 8 +-
pidgin/gtkprefs.h | 60 +-
pidgin/gtkprivacy.h | 8 +-
pidgin/gtkrequest.h | 8 +-
pidgin/gtkroomlist.h | 4 +-
pidgin/gtksavedstatuses.h | 12 +-
pidgin/gtksession.h | 6 +-
pidgin/gtksmiley.h | 26 +-
pidgin/gtksound.h | 14 +-
pidgin/gtkutils.h | 416 +++++++++---------
pidgin/gtkwebview.h | 260 +++++-----
pidgin/gtkwebviewtoolbar.h | 20 +-
pidgin/gtkwhiteboard.h | 2 +-
pidgin/gtkxfer.h | 32 +-
pidgin/minidialog.h | 48 +-
pidgin/pidginstock.h | 2 +-
pidgin/pidgintooltip.h | 58 +-
147 files changed, 5781 insertions(+), 5781 deletions(-)
diffs (truncated from 29477 to 300 lines):
diff --git a/finch/gntaccount.h b/finch/gntaccount.h
--- a/finch/gntaccount.h
+++ b/finch/gntaccount.h
@@ -36,7 +36,7 @@
/**
* Get the ui-functions.
*
- * @return The PurpleAccountUiOps structure populated with the appropriate functions.
+ * Returns: The PurpleAccountUiOps structure populated with the appropriate functions.
*/
PurpleAccountUiOps *finch_accounts_get_ui_ops(void);
@@ -58,7 +58,7 @@ void finch_accounts_show_all(void);
/**
* Show the edit dialog for an account.
*
- * @param account The account to edit, or @c NULL to create a new 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
@@ -55,7 +55,7 @@ typedef struct
/**
* Get the ui-functions.
*
- * @return The PurpleBlistUiOps structure populated with the appropriate functions.
+ * Returns: The PurpleBlistUiOps structure populated with the appropriate functions.
*/
PurpleBlistUiOps * finch_blist_get_ui_ops(void);
@@ -77,82 +77,82 @@ void finch_blist_show(void);
/**
* Get the position of the buddy list.
*
- * @param x The x-coordinate is set here if not @ NULL.
- * @param y The y-coordinate is set here if not @c NULL.
+ * @x: The x-coordinate is set here if not @ NULL.
+ * @y: The y-coordinate is set here if not %NULL.
*
- * @return Returns @c TRUE if the values were set, @c FALSE otherwise.
+ * 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.
*
- * @param x The x-coordinate of the buddy list.
- * @param y The y-coordinate of the buddy list.
+ * @x: The x-coordinate of the buddy list.
+ * @y: The y-coordinate of the buddy list.
*/
void finch_blist_set_position(int x, int y);
/**
* Get the size of the buddy list.
*
- * @param width The width is set here if not @ NULL.
- * @param height The height is set here if not @c NULL.
+ * @width: The width is set here if not @ NULL.
+ * @height: The height is set here if not %NULL.
*
- * @return Returns @c TRUE if the values were set, @c FALSE otherwise.
+ * 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.
*
- * @param width The width of the buddy list.
- * @param height The height of the buddy list.
+ * @width: The width of the buddy list.
+ * @height: The height of the buddy list.
*/
void finch_blist_set_size(int width, int height);
/**
* Get information about a user. Show immediate feedback.
*
- * @param conn The connection to get information fro
- * @param name The user to get information about.
+ * @conn: The connection to get information fro
+ * @name: The user to get information about.
*
- * @return Returns the ui-handle for the userinfo notification.
+ * Returns: Returns the ui-handle for the userinfo notification.
*/
gpointer finch_retrieve_user_info(PurpleConnection *conn, const char *name);
/**
* Get the tree list of the buddy list.
- * @return The GntTree widget.
+ * Returns: The GntTree widget.
*/
GntTree * finch_blist_get_tree(void);
/**
* Add an alternate buddy list manager.
*
- * @param manager The alternate buddylist manager.
+ * @manager: The alternate buddylist manager.
*/
void finch_blist_install_manager(const FinchBlistManager *manager);
/**
* Remove an alternate buddy list manager.
*
- * @param manager The buddy list manager to remove.
+ * @manager: The buddy list manager to remove.
*/
void finch_blist_uninstall_manager(const FinchBlistManager *manager);
/**
* Find a buddy list manager.
*
- * @param id The identifier for the desired buddy list manager.
+ * @id: The identifier for the desired buddy list manager.
*
- * @return The manager with the requested identifier, if available. @c NULL otherwise.
+ * Returns: The manager with the requested identifier, if available. %NULL otherwise.
*/
FinchBlistManager * finch_blist_manager_find(const char *id);
/**
* Request the active buddy list manager to add a node.
*
- * @param node The node to add
+ * @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
@@ -36,7 +36,7 @@
/**
* Get the ui-functions.
*
- * @return The PurpleConnectionUiOps structure populated with the appropriate functions.
+ * Returns: The PurpleConnectionUiOps structure populated with the appropriate functions.
*/
PurpleConnectionUiOps *finch_connections_get_ui_ops(void);
diff --git a/finch/gntconv.h b/finch/gntconv.h
--- a/finch/gntconv.h
+++ b/finch/gntconv.h
@@ -85,7 +85,7 @@ struct _FinchConvIm
/**
* Get the ui-functions.
*
- * @return The PurpleConversationUiOps populated with the appropriate functions.
+ * Returns: The PurpleConversationUiOps populated with the appropriate functions.
*/
PurpleConversationUiOps *finch_conv_get_ui_ops(void);
@@ -102,15 +102,15 @@ void finch_conversation_uninit(void);
/**
* Set a conversation as active in a contactized conversation
*
- * @param conv The conversation to make active.
+ * @conv: The conversation to make active.
*/
void finch_conversation_set_active(PurpleConversation *conv);
/**
* Sets the information widget for the conversation window.
*
- * @param conv The conversation.
- * @param widget The widget containing the information. If @c NULL,
+ * @conv: The conversation.
+ * @widget: The widget containing the information. If %NULL,
* the current information widget is removed.
*/
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
@@ -36,7 +36,7 @@
/**
* Get the ui-functions.
*
- * @return The PurpleDebugUiOps structure populated with the appropriate functions.
+ * Returns: The PurpleDebugUiOps structure populated with the appropriate functions.
*/
PurpleDebugUiOps *finch_debug_get_ui_ops(void);
diff --git a/finch/gntidle.h b/finch/gntidle.h
--- a/finch/gntidle.h
+++ b/finch/gntidle.h
@@ -36,7 +36,7 @@
/**
* Returns the GNT idle UI ops.
*
- * @return The UI operations structure.
+ * Returns: The UI operations structure.
*/
PurpleIdleUiOps *finch_idle_get_ui_ops(void);
diff --git a/finch/gntlog.h b/finch/gntlog.h
--- a/finch/gntlog.h
+++ b/finch/gntlog.h
@@ -68,7 +68,7 @@ void finch_log_init(void);
/**
* Returns the GNT log subsystem handle.
*
- * @return The GNT log subsystem handle.
+ * Returns: The GNT log subsystem handle.
*/
void *finch_log_get_handle(void);
diff --git a/finch/gntmenuutil.h b/finch/gntmenuutil.h
--- a/finch/gntmenuutil.h
+++ b/finch/gntmenuutil.h
@@ -37,9 +37,9 @@
/**
* Add a PurpleMenuAction to a GntMenu.
*
- * @param menu the GntMenu to add to
- * @param action the PurpleMenuAction to add
- * @param ctx the callback context, passed as the first argument to
+ * @menu: the GntMenu to add to
+ * @action: the PurpleMenuAction to add
+ * @ctx: the callback context, passed as the first argument to
* the PurpleMenuAction's PurpleCallback function.
*/
void gnt_append_menu_action(GntMenu *menu, PurpleMenuAction *action, gpointer ctx);
diff --git a/finch/gntnotify.h b/finch/gntnotify.h
--- a/finch/gntnotify.h
+++ b/finch/gntnotify.h
@@ -36,7 +36,7 @@
/**
* Get the ui-functions.
*
- * @return The PurpleNotifyUiOps structure populated with the appropriate functions.
+ * Returns: The PurpleNotifyUiOps structure populated with the appropriate functions.
*/
PurpleNotifyUiOps *finch_notify_get_ui_ops(void);
diff --git a/finch/gntpounce.h b/finch/gntpounce.h
--- a/finch/gntpounce.h
+++ b/finch/gntpounce.h
@@ -31,9 +31,9 @@
/**
* Displays a New Buddy Pounce or Edit Buddy Pounce dialog.
*
- * @param account The optional account to use.
- * @param name The optional name to pounce on.
- * @param cur_pounce The current buddy pounce, if editing an existing one.
+ * @account: The optional account to use.
+ * @name: The optional name to pounce on.
+ * @cur_pounce: The current buddy pounce, if editing an existing one.
*/
void finch_pounce_editor_show(PurpleAccount *account, const char *name,
PurplePounce *cur_pounce);
@@ -51,7 +51,7 @@ void finch_pounces_manager_hide(void);
/**
* Returns the gtkpounces handle
*
- * @return The handle to the GTK+ pounces system
+ * Returns: The handle to the GTK+ pounces system
*/
void *finch_pounces_get_handle(void);
diff --git a/finch/gntrequest.h b/finch/gntrequest.h
--- a/finch/gntrequest.h
+++ b/finch/gntrequest.h
@@ -37,7 +37,7 @@
/**
* Get the ui-functions.
*
- * @return The PurpleRequestUiOps structure populated with the appropriate functions.
+ * Returns: The PurpleRequestUiOps structure populated with the appropriate functions.
*/
PurpleRequestUiOps *finch_request_get_ui_ops(void);
@@ -60,9 +60,9 @@ void finch_request_save_in_prefs(gpointe
/**
* Create a widget field for a request-field.
*
- * @param field The request field.
+ * @field: The request field.
*
- * @return A GntWidget for the request field.
+ * Returns: A GntWidget for the request field.
*/
GntWidget *finch_request_field_get_widget(PurpleRequestField *field);
/*@}*/
diff --git a/finch/gntroomlist.h b/finch/gntroomlist.h
--- a/finch/gntroomlist.h
+++ b/finch/gntroomlist.h
@@ -41,7 +41,7 @@ void finch_roomlist_init(void);
/**
* Get the ui-functions.
*
- * @return The PurpleRoomlistUiOps structure populated with the appropriate functions.
+ * Returns: The PurpleRoomlistUiOps structure populated with the appropriate functions.
More information about the Commits
mailing list