luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-01-26 22:16:16 +01:00
Code Issues Packages Projects Releases Wiki Activity

Add some docs

Browse Source 
svn path=/trunk/; revision=5553
This commit is contained in:
Matthias Clasen 2007-06-13 16:26:59 +00:00
parent 608f55185c
commit 94327cb6a7
2 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/reference/ChangeLog
View File

@ -1,3 +1,9 @@
2007-06-13 Matthias Clasen <mclasen@redhat.com>
* glib/tmpl/warnings.sgml: Add some verbiage about
intended use cases for the g_return macros, inspired
by a bugzilla comment by Havoc Pennington.
2007-06-05 Matthias Clasen <mclasen@redhat.com>
* === Released 2.13.4 ===

11
docs/reference/glib/tmpl/warnings.sgml
View File

@ -8,6 +8,17 @@ functions to output messages and help debug applications.
<para>
These functions provide support for outputting messages.
</para>
<para>
The <function>g_return</function> family of macros (g_return_if_fail(),
g_return_val_if_fail(), g_return_if_reached(), g_return_val_if_reached())
should only be used for programming errors, a typical use case is
checking for invalid parameters at the beginning of a public function.
They should not be used if you just mean "if (error) return", they
should only be used if you mean "if (bug in program) return".
The program behavior is generally considered undefined after one of these
checks fails. They are not intended for normal control flow, only to
give a perhaps-helpful warning before giving up.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>