document allowed uses for 'out' parameters.

* glib/tmpl/macros.sgml (G_CONST_RETURN): document
allowed uses for 'out' parameters.

diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog
index 7683da3..60bc812 100644 (file)
--- a/docs/reference/ChangeLog
+++ b/docs/reference/ChangeLog
@@ -1,5 +1,10 @@
 2001-10-01  Matthias Clasen  <matthiasc@poet.de>
 
+       * glib/tmpl/macros.sgml (G_CONST_RETURN): document
+       allowed uses for 'out' parameters.
+
+2001-10-01  Matthias Clasen  <matthiasc@poet.de>
+
        * glib/tmpl/caches.sgml, glib/tmpl/datalist.sgml,
        glib/tmpl/hash_tables.sgml, glib/tmpl/messages.sgml,
        glib/tmpl/misc_utils.sgml: consistently refer to GTK+.

diff --git a/docs/reference/glib/tmpl/macros.sgml b/docs/reference/glib/tmpl/macros.sgml
index 87a6b60..eee66d4 100644 (file)
--- a/docs/reference/glib/tmpl/macros.sgml
+++ b/docs/reference/glib/tmpl/macros.sgml
@@ -245,8 +245,9 @@ should be used in place of <literal>const</literal> for functions that
 return a value that should not be modified. The purpose of this macro is 
 to allow us to turn on <literal>const</literal> for returned constant 
 strings by default, while allowing programmers who find that annoying to 
-turn it off. This macro should only be used for return values, it doesn't 
-make sense for function arguments.
+turn it off. This macro should only be used for return values and for
+<emphasis>out</emphasis> parameters, it doesn't make sense for 
+<emphasis>in</emphasis> parameters. 
 </para>