/soc/2013/ankitkv/gobjectification: a23769351b31: Remove @see

Ankit Vani a at nevitus.org
Thu Feb 6 09:47:09 EST 2014


Changeset: a23769351b311e4a923c36727ba051344fe3dc4b
Author:	 Ankit Vani <a at nevitus.org>
Date:	 2014-02-06 17:54 +0530
Branch:	 gtkdoc-conversion
URL: https://hg.pidgin.im/soc/2013/ankitkv/gobjectification/rev/a23769351b31

Description:

Remove @see

diffstat:

 finch/libgnt/gntmenuitem.h    |   2 +-
 finch/libgnt/gnttree.h        |  61 ++++++++++++++----------------------------
 libpurple/blistnode.h         |  40 ++++++++++-----------------
 libpurple/buddyicon.h         |   2 +-
 libpurple/buddylist.h         |   6 ++--
 libpurple/cmds.h              |   2 +-
 libpurple/conversation.h      |   6 ++--
 libpurple/conversationtypes.h |   2 +-
 libpurple/debug.h             |  10 +++---
 libpurple/dnsquery.h          |   3 +-
 libpurple/eventloop.h         |   3 +-
 libpurple/http.h              |   4 +-
 libpurple/plugin.h            |  20 +++++--------
 libpurple/prefs.h             |   6 ++--
 libpurple/prpl.h              |   4 +-
 libpurple/request-datasheet.h |   4 +-
 libpurple/request.h           |  12 ++++----
 libpurple/status.h            |   2 +-
 libpurple/util.h              |  41 ++++++++++++++--------------
 pidgin/gtksmiley.h            |   3 +-
 pidgin/gtkutils.h             |   2 +-
 pidgin/minidialog.h           |   3 +-
 22 files changed, 103 insertions(+), 135 deletions(-)

diffs (truncated from 820 to 300 lines):

diff --git a/finch/libgnt/gntmenuitem.h b/finch/libgnt/gntmenuitem.h
--- a/finch/libgnt/gntmenuitem.h
+++ b/finch/libgnt/gntmenuitem.h
@@ -152,7 +152,7 @@ void gnt_menuitem_set_trigger(GntMenuIte
  *
  * Get the trigger key for a menuitem.
  *
- * @see gnt_menuitem_set_trigger
+ * See gnt_menuitem_set_trigger().
  *
  * Returns: The trigger key for the menuitem.
  */
diff --git a/finch/libgnt/gnttree.h b/finch/libgnt/gnttree.h
--- a/finch/libgnt/gnttree.h
+++ b/finch/libgnt/gnttree.h
@@ -118,7 +118,7 @@ GType gnt_tree_get_gtype(void);
  *
  * Returns: The newly created tree
  *
- * @see gnt_tree_new_with_columns
+ * See gnt_tree_new_with_columns().
  */
 GntWidget * gnt_tree_new(void);
 
@@ -128,7 +128,7 @@ GntWidget * gnt_tree_new(void);
  *
  * Create a tree with a specified number of columns.
  *
- * @see gnt_tree_new
+ * See gnt_tree_new().
  *
  * Returns:  The newly created tree
  */
@@ -173,9 +173,7 @@ void gnt_tree_scroll(GntTree *tree, int 
  *
  * Insert a row in the tree.
  *
- * @see gnt_tree_create_row
- * @see gnt_tree_add_row_last
- * @see gnt_tree_add_choice
+ * See gnt_tree_create_row(), gnt_tree_add_row_last(), gnt_tree_add_choice().
  *
  * Returns:  The inserted row
  */
@@ -190,9 +188,7 @@ GntTreeRow * gnt_tree_add_row_after(GntT
  *
  * Insert a row at the end of the tree.
  *
- * @see gnt_tree_create_row
- * @see gnt_tree_add_row_after
- * @see gnt_tree_add_choice
+ * See gnt_tree_create_row(), gnt_tree_add_row_after(), gnt_tree_add_choice().
  *
  * Returns: The inserted row
  */
@@ -214,8 +210,7 @@ gpointer gnt_tree_get_selection_data(Gnt
  *
  * Get the text displayed for the selected row.
  *
- * @see gnt_tree_get_row_text_list
- * @see gnt_tree_get_selection_text_list
+ * See gnt_tree_get_row_text_list(), gnt_tree_get_selection_text_list().
  *
  * Returns:  The text, which needs to be freed by the caller
  */
@@ -230,8 +225,7 @@ char * gnt_tree_get_selection_text(GntTr
  *
  * Get a list of text for a row.
  *
- * @see gnt_tree_get_selection_text_list
- * @see gnt_tree_get_selection_text
+ * See gnt_tree_get_selection_text_list(), gnt_tree_get_selection_text().
  *
  * Returns: A list of texts of a row. The list and its data should be
  *         freed by the caller. The caller should make sure that if
@@ -310,8 +304,7 @@ GntTreeRow * gnt_tree_row_get_parent(Gnt
  *
  * Get a list of text of the current row.
  *
- * @see gnt_tree_get_row_text_list
- * @see gnt_tree_get_selection_text
+ * See gnt_tree_get_row_text_list(), gnt_tree_get_selection_text().
  *
  * Returns: A list of texts of the currently selected row. The list
  *         and its data should be freed by the caller. The caller
@@ -378,10 +371,8 @@ void gnt_tree_change_text(GntTree *tree,
  *
  * Add a checkable item in the tree.
  *
- * @see gnt_tree_create_row
- * @see gnt_tree_create_row_from_list
- * @see gnt_tree_add_row_last
- * @see gnt_tree_add_row_after
+ * See gnt_tree_create_row(), gnt_tree_create_row_from_list(),
+ *     gnt_tree_add_row_last(), gnt_tree_add_row_after().
  *
  * Returns:  The row inserted.
  */
@@ -446,10 +437,8 @@ void gnt_tree_set_selected(GntTree *tree
  *
  * Create a row to insert in the tree.
  *
- * @see gnt_tree_create_row_from_list
- * @see gnt_tree_add_row_after
- * @see gnt_tree_add_row_last
- * @see gnt_tree_add_choice
+ * See gnt_tree_create_row_from_list(), gnt_tree_add_row_after(),
+ *     gnt_tree_add_row_last(), gnt_tree_add_choice().
  *
  * Returns:   The row
  */
@@ -462,10 +451,8 @@ GntTreeRow * gnt_tree_create_row(GntTree
  *
  * Create a row from a list of text.
  *
- * @see gnt_tree_create_row
- * @see gnt_tree_add_row_after
- * @see gnt_tree_add_row_last
- * @see gnt_tree_add_choice
+ * See gnt_tree_create_row(), gnt_tree_add_row_after(), gnt_tree_add_row_last(),
+ *     gnt_tree_add_choice().
  *
  * Returns:   The row
  */
@@ -479,8 +466,7 @@ GntTreeRow * gnt_tree_create_row_from_li
  *
  * Set the width of a column in the tree.
  *
- * @see gnt_tree_set_column_width_ratio
- * @see gnt_tree_set_column_resizable
+ * See gnt_tree_set_column_width_ratio(), gnt_tree_set_column_resizable()
  */
 void gnt_tree_set_col_width(GntTree *tree, int col, int width);
 
@@ -492,8 +478,7 @@ void gnt_tree_set_col_width(GntTree *tre
  *
  * Set the title for a column.
  *
- * @see gnt_tree_set_column_titles
- * @see gnt_tree_set_show_title
+ * See gnt_tree_set_column_titles(), gnt_tree_set_show_title().
  *
  * Since: 2.0.0 (gnt), 2.1.0 (pidgin)
  */
@@ -506,8 +491,7 @@ void gnt_tree_set_column_title(GntTree *
  *
  * Set the titles of the columns
  *
- * @see gnt_tree_set_column_title
- * @see gnt_tree_set_show_title
+ * See gnt_tree_set_column_title(), gnt_tree_set_show_title().
  */
 void gnt_tree_set_column_titles(GntTree *tree, ...);
 
@@ -518,8 +502,7 @@ void gnt_tree_set_column_titles(GntTree 
  *
  * Set whether to display the title of the columns.
  *
- * @see gnt_tree_set_column_title
- * @see gnt_tree_set_column_titles
+ * See gnt_tree_set_column_title(), gnt_tree_set_column_titles().
  */
 void gnt_tree_set_show_title(GntTree *tree, gboolean set);
 
@@ -531,7 +514,7 @@ void gnt_tree_set_show_title(GntTree *tr
  *
  * Set the compare function for sorting the data.
  *
- * @see gnt_tree_sort_row
+ * See gnt_tree_sort_row().
  */
 void gnt_tree_set_compare_func(GntTree *tree, GCompareFunc func);
 
@@ -561,7 +544,7 @@ void gnt_tree_set_show_separator(GntTree
  *
  * Sort a row in the tree.
  *
- * @see gnt_tree_set_compare_func
+ * See gnt_tree_set_compare_func().
  */
 void gnt_tree_sort_row(GntTree *tree, void *row);
 
@@ -607,8 +590,7 @@ void gnt_tree_set_column_visible(GntTree
  * Set whether a column can be resized to keep the same ratio when the
  * tree is resized.
  *
- * @see gnt_tree_set_col_width
- * @see gnt_tree_set_column_width_ratio
+ * See gnt_tree_set_col_width(), gnt_tree_set_column_width_ratio().
  *
  * Since: 2.0.0 (gnt), 2.1.0 (pidgin)
  */
@@ -647,8 +629,7 @@ void gnt_tree_set_column_is_right_aligne
  * Set column widths to use when calculating column widths after a tree
  * is resized.
  *
- * @see gnt_tree_set_col_width
- * @see gnt_tree_set_column_resizable
+ * See gnt_tree_set_col_width(), gnt_tree_set_column_resizable().
  *
  * Since: 2.0.0 (gnt), 2.1.0 (pidgin)
  */
diff --git a/libpurple/blistnode.h b/libpurple/blistnode.h
--- a/libpurple/blistnode.h
+++ b/libpurple/blistnode.h
@@ -149,12 +149,10 @@ GType purple_blist_node_get_type(void);
  * Returns the next node of a given node. This function is to be used to iterate
  * over the tree returned by purple_blist_get_buddy_list.
  *
+ * See purple_blist_node_get_parent(), purple_blist_node_get_first_child(),
+ *   purple_blist_node_get_sibling_next(), purple_blist_node_get_sibling_prev().
+ *
  * Returns:	The next node
- *
- * @see purple_blist_node_get_parent
- * @see purple_blist_node_get_first_child
- * @see purple_blist_node_get_sibling_next
- * @see purple_blist_node_get_sibling_prev
  */
 PurpleBlistNode *purple_blist_node_next(PurpleBlistNode *node, gboolean offline);
 
@@ -164,12 +162,10 @@ PurpleBlistNode *purple_blist_node_next(
  *
  * Returns the parent node of a given node.
  *
+ * See purple_blist_node_get_first_child(), purple_blist_node_get_sibling_next(),
+ *     purple_blist_node_get_sibling_prev(), purple_blist_node_next().
+ *
  * Returns:  The parent node.
- *
- * @see purple_blist_node_get_first_child
- * @see purple_blist_node_get_sibling_next
- * @see purple_blist_node_get_sibling_prev
- * @see purple_blist_node_next
  */
 PurpleBlistNode *purple_blist_node_get_parent(PurpleBlistNode *node);
 
@@ -179,12 +175,10 @@ PurpleBlistNode *purple_blist_node_get_p
  *
  * Returns the the first child node of a given node.
  *
+ * See purple_blist_node_get_parent(), purple_blist_node_get_sibling_next(),
+ *     purple_blist_node_get_sibling_prev(), purple_blist_node_next().
+ *
  * Returns:  The child node.
- *
- * @see purple_blist_node_get_parent
- * @see purple_blist_node_get_sibling_next
- * @see purple_blist_node_get_sibling_prev
- * @see purple_blist_node_next
  */
 PurpleBlistNode *purple_blist_node_get_first_child(PurpleBlistNode *node);
 
@@ -194,12 +188,10 @@ PurpleBlistNode *purple_blist_node_get_f
  *
  * Returns the sibling node of a given node.
  *
+ * See purple_blist_node_get_parent(), purple_blist_node_get_first_child(),
+ *     purple_blist_node_get_sibling_prev(), purple_blist_node_next().
+ *
  * Returns:  The sibling node.
- *
- * @see purple_blist_node_get_parent
- * @see purple_blist_node_get_first_child
- * @see purple_blist_node_get_sibling_prev
- * @see purple_blist_node_next
  */
 PurpleBlistNode *purple_blist_node_get_sibling_next(PurpleBlistNode *node);
 
@@ -209,12 +201,10 @@ PurpleBlistNode *purple_blist_node_get_s
  *
  * Returns the previous sibling node of a given node.
  *
+ * See purple_blist_node_get_parent(), purple_blist_node_get_first_child(),
+ *     purple_blist_node_get_sibling_next(), purple_blist_node_next().
+ *
  * Returns:  The sibling node.
- *
- * @see purple_blist_node_get_parent
- * @see purple_blist_node_get_first_child
- * @see purple_blist_node_get_sibling_next
- * @see purple_blist_node_next
  */
 PurpleBlistNode *purple_blist_node_get_sibling_prev(PurpleBlistNode *node);
 
diff --git a/libpurple/buddyicon.h b/libpurple/buddyicon.h
--- a/libpurple/buddyicon.h
+++ b/libpurple/buddyicon.h
@@ -352,7 +352,7 @@ purple_buddy_icons_node_set_custom_icon(
  * Sets a custom buddy icon for a blist node.
  *
  * Convenience wrapper around purple_buddy_icons_node_set_custom_icon.
- * @see purple_buddy_icons_node_set_custom_icon()
+ * See purple_buddy_icons_node_set_custom_icon().
  *
  * Returns: The icon that was set. The caller does NOT own a reference to this,
  *         and must call purple_imgstore_ref() if it wants one.
diff --git a/libpurple/buddylist.h b/libpurple/buddylist.h
--- a/libpurple/buddylist.h
+++ b/libpurple/buddylist.h



More information about the Commits mailing list