Improve the docs

svn path=/trunk/; revision=7702

diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog
index b10413a..0adf39b 100644 (file)
--- a/docs/reference/ChangeLog
+++ b/docs/reference/ChangeLog
@@ -1,3 +1,10 @@
+@008-11-28  Matthias Clasen  <mclasen@redhat.com>
+
+       Bug 562549 – g_byte_array_free should tell how free data
+
+       * glib/tmpl/arrays_byte.sgml: Improve docs, proposed by
+       Guillaume Desmottes
+
 2008-11-21  Matthias Clasen  <mclasen@redhat.com>
 
        * glib/Makefile.am:

diff --git a/docs/reference/glib/tmpl/arrays_byte.sgml b/docs/reference/glib/tmpl/arrays_byte.sgml
index 0e98653..f877415 100644 (file)
--- a/docs/reference/glib/tmpl/arrays_byte.sgml
+++ b/docs/reference/glib/tmpl/arrays_byte.sgml
@@ -186,6 +186,8 @@ If @free_segment is %TRUE it frees the actual byte data.
 
 @array: a #GByteArray.
 @free_segment: if %TRUE the actual byte data is freed as well.
-@Returns: the element data if @free_segment is %FALSE, otherwise %NULL
+@Returns: the element data if @free_segment is %FALSE, otherwise %NULL.
+        The element data should be freed using g_free().
+