Document that this function may not return.

2004-11-02  Matthias Clasen  <mclasen@redhat.com>

	* glib/goption.c (g_option_context_parse): Document that
	this function may not return.
This commit is contained in:
Matthias Clasen 2004-11-02 05:11:10 +00:00 committed by Matthias Clasen
parent b8f2678c86
commit 91ae46c37b
6 changed files with 31 additions and 0 deletions

View File

@ -1,3 +1,8 @@
2004-11-02 Matthias Clasen <mclasen@redhat.com>
* glib/goption.c (g_option_context_parse): Document that
this function may not return.
2004-11-01 Matthias Clasen <mclasen@redhat.com>
* glib/gutils.h: Make gtkdoc-scan happy by removing spaces

View File

@ -1,3 +1,8 @@
2004-11-02 Matthias Clasen <mclasen@redhat.com>
* glib/goption.c (g_option_context_parse): Document that
this function may not return.
2004-11-01 Matthias Clasen <mclasen@redhat.com>
* glib/gutils.h: Make gtkdoc-scan happy by removing spaces

View File

@ -1,3 +1,8 @@
2004-11-02 Matthias Clasen <mclasen@redhat.com>
* glib/goption.c (g_option_context_parse): Document that
this function may not return.
2004-11-01 Matthias Clasen <mclasen@redhat.com>
* glib/gutils.h: Make gtkdoc-scan happy by removing spaces

View File

@ -1,3 +1,8 @@
2004-11-02 Matthias Clasen <mclasen@redhat.com>
* glib/goption.c (g_option_context_parse): Document that
this function may not return.
2004-11-01 Matthias Clasen <mclasen@redhat.com>
* glib/gutils.h: Make gtkdoc-scan happy by removing spaces

View File

@ -1,3 +1,8 @@
2004-11-02 Matthias Clasen <mclasen@redhat.com>
* glib/goption.c (g_option_context_parse): Document that
this function may not return.
2004-11-01 Matthias Clasen <mclasen@redhat.com>
* glib/gutils.h: Make gtkdoc-scan happy by removing spaces

View File

@ -1056,6 +1056,12 @@ free_pending_nulls (GOptionContext *context,
* removed from the array and @argc and @argv are updated
* accordingly. In case of an error, @argc and @argv are
* left unmodified.
*
* If automatic <option>--help</option> support is enabled
* (see g_option_context_set_help_enabled()), and the
* @argv array contains one of the recognized help options,
* this function will produce help output to stdout and
* call <literal>exit (0)</literal>.
*
* Return value: %TRUE if the parsing was successful,
* %FALSE if an error occurred