diff --git a/glib/goption.c b/glib/goption.c index ff762e831..167a7df46 100644 --- a/glib/goption.c +++ b/glib/goption.c @@ -28,7 +28,7 @@ * following example: * * testtreemodel -r 1 --max-size 20 --rand --display=:1.0 -vb -- file1 file2 - * + * * The example demonstrates a number of features of the GOption commandline parser * * Options can be single letters, prefixed by a single dash. Multiple @@ -36,25 +36,27 @@ * * Long options are prefixed by two consecutive dashes. * - * Options can have an extra argument, which can be a number, a string or a - * filename. For long options, the extra argument can be appended with an - * equals sign after the option name. + * Options can have an extra argument, which can be a number, a string or a + * filename. For long options, the extra argument can be appended with an + * equals sign after the option name, which is useful if the extra argument + * starts with a dash, which would otherwise cause it to be interpreted + * as another option. * * Non-option arguments are returned to the application as rest arguments. * - * An argument consisting solely of two dashes turns off further parsing, - * any remaining arguments (even those starting with a dash) are returned + * An argument consisting solely of two dashes turns off further parsing, + * any remaining arguments (even those starting with a dash) are returned * to the application as rest arguments. * - * - * Another important feature of GOption is that it can automatically generate - * nicely formatted help output. Unless it is explicitly turned off with - * g_option_context_set_help_enabled(), GOption will recognize the + * + * Another important feature of GOption is that it can automatically generate + * nicely formatted help output. Unless it is explicitly turned off with + * g_option_context_set_help_enabled(), GOption will recognize the * , , - * and groupname options - * (where groupname is the name of a #GOptionGroup) + * and groupname options + * (where groupname is the name of a #GOptionGroup) * and write a text similar to the one shown in the following example to stdout. - * + * * * Usage: * testtreemodel [OPTION...] - test tree model performance