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

Reword some docs comments to avoid 'Returns ...'

Browse Source 
If gtk-doc sees 'Returns ...' written in the text of the documentation
for a macro, it thinks that you are talking about the return value.

Avoid doing that and use 'Returns:' explicitly if we mean to.
This commit is contained in:
Ryan Lortie 2011-07-22 12:57:59 +02:00
parent a0ed253718
commit 4f36eb0f6d
2 changed files with 20 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
glib/gmessages.h
View File

@ -273,11 +273,13 @@ GPrintFunc g_set_printerr_handler (GPrintFunc func);
* g_return_if_fail:
* @expr: the expression to check
*
* Returns from the current function if the expression
* is not true. If the expression evaluates to %FALSE,
* a critical message is logged and the function returns.
* This can only be used in functions which do not return
* a value.
* Verifies that the expression evaluates to %TRUE. If the expression
* evaluates to %FALSE, a critical message is logged and the current
* function returns. This can only be used in functions which do not
* return a value.
*
* If G_DISABLE_CHECKS is defined then the check is not performed. You
* should therefore not depend on any side effects of @expr.
*/
#define g_return_if_fail(expr) G_STMT_START{ (void)0; }G_STMT_END
@ -287,9 +289,12 @@ GPrintFunc g_set_printerr_handler (GPrintFunc func);
* @val: the value to return from the current function
* if the expression is not true
*
* Returns from the current function, returning the value @val,
* if the expression is not true. If the expression evaluates
* to %FALSE, a critical message is logged and @val is returned.
* Verifies that the expression evaluates to %TRUE. If the expression
* evaluates to %FALSE, a critical message is logged and @val is
* returned from the current function.
*
* If G_DISABLE_CHECKS is defined then the check is not performed. You
* should therefore not depend on any side effects of @expr.
*/
#define g_return_val_if_fail(expr,val) G_STMT_START{ (void)0; }G_STMT_END

10
glib/gutils.h
View File

@ -452,9 +452,8 @@ const gchar * glib_check_version (guint required_major,
* @minor: the minor version to check for
* @micro: the micro version to check for
*
* Checks the version of the GLib library.
* Returns %TRUE if the version of the GLib header files
* is the same as or newer than the passed-in version.
* Checks the version of the GLib library that is being compiled
* against.
*
* <example>
* <title>Checking the version of the GLib library</title>
@ -463,6 +462,11 @@ const gchar * glib_check_version (guint required_major,
* g_error ("GLib version 1.2.0 or above is needed");
* </programlisting>
* </example>
*
* See glib_check_version() for a runtime check.
*
* Returns: %TRUE if the version of the GLib header files
* is the same as or newer than the passed-in version.
*/
#define GLIB_CHECK_VERSION(major,minor,micro) \
(GLIB_MAJOR_VERSION > (major) || \