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

Improve the description of parameter_string in the docs. (#336085, Claudio

Browse Source 
2006-03-26  Matthias Clasen  <mclasen@redhat.com>

        * glib/goption.c (g_option_context_new): Improve the description
        of parameter_string in the docs.  (#336085, Claudio Saavedra)
This commit is contained in:
Matthias Clasen 2006-03-26 20:15:19 +00:00 committed by Matthias Clasen
parent f0ee594a80
commit a205620a88
3 changed files with 27 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
ChangeLog
View File

@ -1,3 +1,8 @@
2006-03-26 Matthias Clasen <mclasen@redhat.com>
* glib/goption.c (g_option_context_new): Improve the description
of parameter_string in the docs. (#336085, Claudio Saavedra)
2006-03-24 Martyn Russell <martyn@imendio.com> 2006-03-24 Martyn Russell <martyn@imendio.com>
* glib/gthreadpool.c: Updated the documentation to explain that * glib/gthreadpool.c: Updated the documentation to explain that

5
ChangeLog.pre-2-12
View File

@ -1,3 +1,8 @@
2006-03-26 Matthias Clasen <mclasen@redhat.com>
* glib/goption.c (g_option_context_new): Improve the description
of parameter_string in the docs. (#336085, Claudio Saavedra)
2006-03-24 Martyn Russell <martyn@imendio.com> 2006-03-24 Martyn Russell <martyn@imendio.com>
* glib/gthreadpool.c: Updated the documentation to explain that * glib/gthreadpool.c: Updated the documentation to explain that

18
glib/goption.c
View File

@ -128,11 +128,27 @@ g_option_error_quark (void)
/** /**
* g_option_context_new: * g_option_context_new:
* @parameter_string: a string which is displayed in * @parameter_string: a string which is displayed in
* the first line of <option>--help</option> output, after * the first line of <option>--help</option> output, after the
* usage summary
* <literal><replaceable>programname</replaceable> [OPTION...]</literal> * <literal><replaceable>programname</replaceable> [OPTION...]</literal>
* *
* Creates a new option context. * Creates a new option context.
* *
* The @parameter_text can serve multiple purposes. It can be used
* to add descriptions for "rest" arguments, which are not parsed by
* the #GOptionContext, typically something like "FILES" or
* "FILE1 FILE2...". (If you are using #G_OPTION_REMAINING for
* collecting "rest" arguments, GLib handles this automatically by
* using the @arg_description of the corresponding #GOptionEntry in
* the usage summary.)
*
* Another common usage is to give a summary of the program
* functionality. This can be a short summary on the same line,
* like " - frob the strings", or a longer description in a paragraph
* below the usage summary. In this case, @parameter_string should start
* with two newlines, to separate the description from the usage summary:
* "\n\nA program to frob strings, which will..."
*
* Returns: a newly created #GOptionContext, which must be * Returns: a newly created #GOptionContext, which must be
* freed with g_option_context_free() after use. * freed with g_option_context_free() after use.
* *