X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=glib%2Fgtree.c;h=7fb41c24f79cf9377ab1d61cde069b4ae132a088;hb=2a53b4d0e2c98a14aedf31e38f0ad1fb2e8fe26f;hp=803b2aa1bbdee86b9fb30f6ee7f21fccabd89004;hpb=078dbda148a81af1b3a76fbda72f089b963087f1;p=platform%2Fupstream%2Fglib.git
diff --git a/glib/gtree.c b/glib/gtree.c
index 803b2aa..7fb41c2 100644
--- a/glib/gtree.c
+++ b/glib/gtree.c
@@ -71,9 +71,9 @@ typedef struct _GTreeNode GTreeNode;
/**
* GTree:
*
- * The #GTree-struct is an opaque data structure representing a Balanced Binary Tree.
- * It should be accessed only by using the following functions.
+ * The GTree struct is an opaque data structure representing a
+ * [balanced binary tree][glib-Balanced-Binary-Trees]. It should be
+ * accessed only by using the following functions.
*/
struct _GTree
{
@@ -156,7 +156,7 @@ g_tree_node_new (gpointer key,
*
* Creates a new #GTree.
*
- * Return value: a newly allocated #GTree
+ * Returns: a newly allocated #GTree
*/
GTree *
g_tree_new (GCompareFunc key_compare_func)
@@ -175,7 +175,7 @@ g_tree_new (GCompareFunc key_compare_func)
* Creates a new #GTree with a comparison function that accepts user data.
* See g_tree_new() for more details.
*
- * Return value: a newly allocated #GTree
+ * Returns: a newly allocated #GTree
*/
GTree *
g_tree_new_with_data (GCompareDataFunc key_compare_func,
@@ -202,7 +202,7 @@ g_tree_new_with_data (GCompareDataFunc key_compare_func,
* to free the memory allocated for the key and value that get called when
* removing the entry from the #GTree.
*
- * Return value: a newly allocated #GTree
+ * Returns: a newly allocated #GTree
*/
GTree *
g_tree_new_full (GCompareDataFunc key_compare_func,
@@ -305,7 +305,7 @@ g_tree_remove_all (GTree *tree)
*
* It is safe to call this function from any thread.
*
- * Return value: the passed in #GTree
+ * Returns: the passed in #GTree
*
* Since: 2.22
*/
@@ -833,8 +833,8 @@ g_tree_remove_internal (GTree *tree,
* automatically balanced as key/value pairs are added, key lookup
* is O(log n) (where n is the number of key/value pairs in the tree).
*
- * Return value: the value corresponding to the key, or %NULL
- * if the key was not found.
+ * Returns: the value corresponding to the key, or %NULL
+ * if the key was not found
*/
gpointer
g_tree_lookup (GTree *tree,
@@ -861,7 +861,7 @@ g_tree_lookup (GTree *tree,
* allocated for the original key, for example before calling
* g_tree_remove().
*
- * Return value: %TRUE if the key was found in the #GTree
+ * Returns: %TRUE if the key was found in the #GTree
*/
gboolean
g_tree_lookup_extended (GTree *tree,
@@ -940,8 +940,7 @@ g_tree_foreach (GTree *tree,
* Deprecated:2.2: The order of a balanced tree is somewhat arbitrary.
* If you just want to visit all nodes in sorted order, use
* g_tree_foreach() instead. If you really need to visit nodes in
- * a different order, consider using an
- * N-ary Tree.
+ * a different order, consider using an [n-ary tree][glib-N-ary-Trees].
*/
/**
* GTraverseFunc:
@@ -1003,8 +1002,8 @@ g_tree_traverse (GTree *tree,
* @search_func returns 1, searching will proceed among the key/value
* pairs that have a larger key.
*
- * Return value: the value corresponding to the found key, or %NULL
- * if the key was not found.
+ * Returns: the value corresponding to the found key, or %NULL
+ * if the key was not found
*/
gpointer
g_tree_search (GTree *tree,
@@ -1029,7 +1028,7 @@ g_tree_search (GTree *tree,
* If the #GTree contains only one root node the height is 1.
* If the root node has children the height is 2, etc.
*
- * Return value: the height of @tree
+ * Returns: the height of @tree
*/
gint
g_tree_height (GTree *tree)
@@ -1062,7 +1061,7 @@ g_tree_height (GTree *tree)
*
* Gets the number of nodes in a #GTree.
*
- * Return value: the number of nodes in @tree
+ * Returns: the number of nodes in @tree
*/
gint
g_tree_nnodes (GTree *tree)