luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-07-22 09:57:52 +02:00
Code Issues Packages Projects Releases Wiki Activity

document allowed uses for 'out' parameters.

Browse Source 
* glib/tmpl/macros.sgml (G_CONST_RETURN): document
allowed uses for 'out' parameters.
This commit is contained in:
Matthias Clasen
2001-10-01 18:19:02 +00:00
parent a6e1fafdc9
commit 66fb9a2951
2 changed files with 8 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
docs/reference/ChangeLog
View File

@@ -1,3 +1,8 @@
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,

5
docs/reference/glib/tmpl/macros.sgml
View File

@@ -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>