Clarify some docs. (#302062, Matthew F. Barnes)

2005-04-29  Matthias Clasen  <mclasen@redhat.com>

	* glib/gtree.c: Clarify some docs. (#302062, Matthew F. Barnes)

diff --git a/ChangeLog b/ChangeLog
index 9184fd3..7bbbc87 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,7 @@
+2005-04-29  Matthias Clasen  <mclasen@redhat.com>
+
+       * glib/gtree.c: Clarify some docs. (#302062, Matthew F. Barnes)
+
 2005-04-28  Matthias Clasen  <mclasen@redhat.com>
 
        * glib/gstrfuncs.c (g_strcompress): Warn and don't crash

diff --git a/ChangeLog.pre-2-10 b/ChangeLog.pre-2-10
index 9184fd3..7bbbc87 100644 (file)
--- a/ChangeLog.pre-2-10
+++ b/ChangeLog.pre-2-10
@@ -1,3 +1,7 @@
+2005-04-29  Matthias Clasen  <mclasen@redhat.com>
+
+       * glib/gtree.c: Clarify some docs. (#302062, Matthew F. Barnes)
+
 2005-04-28  Matthias Clasen  <mclasen@redhat.com>
 
        * glib/gstrfuncs.c (g_strcompress): Warn and don't crash

diff --git a/ChangeLog.pre-2-12 b/ChangeLog.pre-2-12
index 9184fd3..7bbbc87 100644 (file)
--- a/ChangeLog.pre-2-12
+++ b/ChangeLog.pre-2-12
@@ -1,3 +1,7 @@
+2005-04-29  Matthias Clasen  <mclasen@redhat.com>
+
+       * glib/gtree.c: Clarify some docs. (#302062, Matthew F. Barnes)
+
 2005-04-28  Matthias Clasen  <mclasen@redhat.com>
 
        * glib/gstrfuncs.c (g_strcompress): Warn and don't crash

diff --git a/ChangeLog.pre-2-8 b/ChangeLog.pre-2-8
index 9184fd3..7bbbc87 100644 (file)
--- a/ChangeLog.pre-2-8
+++ b/ChangeLog.pre-2-8
@@ -1,3 +1,7 @@
+2005-04-29  Matthias Clasen  <mclasen@redhat.com>
+
+       * glib/gtree.c: Clarify some docs. (#302062, Matthew F. Barnes)
+
 2005-04-28  Matthias Clasen  <mclasen@redhat.com>
 
        * glib/gstrfuncs.c (g_strcompress): Warn and don't crash

diff --git a/glib/gtree.c b/glib/gtree.c
index 3eb8667..2c5d1e0 100644 (file)
--- 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,