* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
- * License along with this library; if not, write to the
- * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- * Boston, MA 02111-1307, USA.
+ * License along with this library; if not, see <http://www.gnu.org/licenses/>.
*/
/*
/**
* GTree:
*
- * The <structname>GTree</structname> struct is an opaque data
- * structure representing a <link
- * linkend="glib-Balanced-Binary-Trees">Balanced Binary Tree</link>. 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
{
*
* Creates a new #GTree.
*
- * Return value: a newly allocated #GTree
+ * Returns: a newly allocated #GTree
*/
GTree *
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,
* 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,
*
* It is safe to call this function from any thread.
*
- * Return value: the passed in #GTree
+ * Returns: the passed in #GTree
*
* Since: 2.22
*/
* 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,
* 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,
* 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
- * <link linkend="glib-N-ary-Trees">N-ary Tree</link>.
+ * a different order, consider using an [n-ary tree][glib-N-ary-Trees].
*/
/**
* GTraverseFunc:
* @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,
* 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)
*
* 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)