Hint that @error should be set in error cases. (#334646, Christian Persch)

2006-03-15  Matthias Clasen  <mclasen@redhat.com>

	* glib/tmpl/option.sgml: Hint that @error should
	be set in error cases.  (#334646, Christian Persch)
This commit is contained in:
Matthias Clasen 2006-03-15 13:46:49 +00:00 committed by Matthias Clasen
parent 79a5c739a4
commit fd91e6aa5b
2 changed files with 9 additions and 5 deletions

View File

@ -1,3 +1,8 @@
2006-03-15 Matthias Clasen <mclasen@redhat.com>
* glib/tmpl/option.sgml: Hint that @error should
be set in error cases. (#334646, Christian Persch)
2006-03-09 Matthias Clasen <mclasen@redhat.com>
* glib/templ/timers.sgml: Mention that the second

View File

@ -162,7 +162,7 @@ options.
@error: A return location for errors. The error code %G_OPTION_ERROR_FAILED
is intended to be used for errors in #GOptionArgFunc callbacks.
@Returns: %TRUE if the option was successfully parsed, %FALSE if an error
occurred
occurred, in which case @error should be set with g_set_error()
<!-- ##### STRUCT GOptionContext ##### -->
@ -441,7 +441,7 @@ the application can then add to its #GOptionContext.
<!-- ##### USER_FUNCTION GOptionParseFunc ##### -->
<para>
The type of function that can be called before and after parsing.
The type of function that can be called before and after parsing.
</para>
@context: The active #GOptionContext
@ -450,7 +450,7 @@ The type of function that can be called before and after parsing.
was created with g_option_group_new()
@error: A return location for error details
@Returns: %TRUE if the function completed successfully, %FALSE if an error
occurred
occurred, in which case @error should be set with g_set_error()
<!-- ##### FUNCTION g_option_group_set_parse_hooks ##### -->
@ -465,8 +465,7 @@ The type of function that can be called before and after parsing.
<!-- ##### USER_FUNCTION GOptionErrorFunc ##### -->
<para>
The type of function to be used as callback when a parse error
occurs.
The type of function to be used as callback when a parse error occurs.
</para>
@context: The active #GOptionContext