diff options
Diffstat (limited to 'glib/gmessages.c')
| -rw-r--r-- | glib/gmessages.c | 19 |
1 files changed, 10 insertions, 9 deletions
diff --git a/glib/gmessages.c b/glib/gmessages.c index 4fdc5ff0b..b1dc70874 100644 --- a/glib/gmessages.c +++ b/glib/gmessages.c @@ -33,15 +33,16 @@ * * These functions provide support for outputting messages. * - * 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. + * The g_return() 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. */ #include "config.h" |