From b2401b8e3d0b5782e9fe55c2ed1b0e68a4892ea4 Mon Sep 17 00:00:00 2001 From: Matthias Clasen Date: Fri, 29 Apr 2005 18:29:42 +0000 Subject: [PATCH] Clarify some docs. (#302062, Matthew F. Barnes) 2005-04-29 Matthias Clasen * glib/gtree.c: Clarify some docs. (#302062, Matthew F. Barnes) --- ChangeLog | 4 ++++ ChangeLog.pre-2-10 | 4 ++++ ChangeLog.pre-2-12 | 4 ++++ ChangeLog.pre-2-8 | 4 ++++ glib/gtree.c | 6 +++++- 5 files changed, 21 insertions(+), 1 deletion(-) diff --git a/ChangeLog b/ChangeLog index 7766db474..1c0668790 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,7 @@ +2005-04-29 Matthias Clasen + + * glib/gtree.c: Clarify some docs. (#302062, Matthew F. Barnes) + 2005-04-28 Matthias Clasen * glib/gstrfuncs.c (g_strcompress): Warn and don't crash diff --git a/ChangeLog.pre-2-10 b/ChangeLog.pre-2-10 index 7766db474..1c0668790 100644 --- a/ChangeLog.pre-2-10 +++ b/ChangeLog.pre-2-10 @@ -1,3 +1,7 @@ +2005-04-29 Matthias Clasen + + * glib/gtree.c: Clarify some docs. (#302062, Matthew F. Barnes) + 2005-04-28 Matthias Clasen * glib/gstrfuncs.c (g_strcompress): Warn and don't crash diff --git a/ChangeLog.pre-2-12 b/ChangeLog.pre-2-12 index 7766db474..1c0668790 100644 --- a/ChangeLog.pre-2-12 +++ b/ChangeLog.pre-2-12 @@ -1,3 +1,7 @@ +2005-04-29 Matthias Clasen + + * glib/gtree.c: Clarify some docs. (#302062, Matthew F. Barnes) + 2005-04-28 Matthias Clasen * glib/gstrfuncs.c (g_strcompress): Warn and don't crash diff --git a/ChangeLog.pre-2-8 b/ChangeLog.pre-2-8 index 7766db474..1c0668790 100644 --- a/ChangeLog.pre-2-8 +++ b/ChangeLog.pre-2-8 @@ -1,3 +1,7 @@ +2005-04-29 Matthias Clasen + + * glib/gtree.c: Clarify some docs. (#302062, Matthew F. Barnes) + 2005-04-28 Matthias Clasen * glib/gstrfuncs.c (g_strcompress): Warn and don't crash diff --git a/glib/gtree.c b/glib/gtree.c index 3eb8667b3..2c5d1e076 100644 --- a/glib/gtree.c +++ b/glib/gtree.c @@ -340,6 +340,7 @@ g_tree_replace (GTree *tree, * If the #GTree was created using g_tree_new_full(), the key and value * are freed using the supplied destroy functions, otherwise you have to * make sure that any dynamically allocated values are freed yourself. + * If the key does not exist in the #GTree, the function does nothing. **/ void g_tree_remove (GTree *tree, @@ -357,6 +358,8 @@ g_tree_remove (GTree *tree, * * Removes a key and its associated value from a #GTree without calling * the key and value destroy functions. + * + * If the key does not exist in the #GTree, the function does nothing. **/ void g_tree_steal (GTree *tree, @@ -376,7 +379,8 @@ g_tree_steal (GTree *tree, * automatically balanced as key/value pairs are added, key lookup is very * fast. * - * Return value: the value corresponding to the key. + * Return value: the value corresponding to the key, or %NULL if the key was + * not found. **/ gpointer g_tree_lookup (GTree *tree,