goption: Convert docs to markdown

In particular, convert lists to markdown syntax.
This commit is contained in:
Matthias Clasen 2014-02-01 10:17:28 -05:00
parent f7a6046998
commit 8f486ceebb

View File

@ -29,25 +29,25 @@
* <literal>testtreemodel -r 1 --max-size 20 --rand --display=:1.0 -vb -- file1 file2</literal> * <literal>testtreemodel -r 1 --max-size 20 --rand --display=:1.0 -vb -- file1 file2</literal>
* *
* The example demonstrates a number of features of the GOption * The example demonstrates a number of features of the GOption
* commandline parser * commandline parser:
* <itemizedlist><listitem><para> *
* Options can be single letters, prefixed by a single dash. Multiple * - Options can be single letters, prefixed by a single dash.
* short options can be grouped behind a single dash. *
* </para></listitem><listitem><para> * - Multiple short options can be grouped behind a single dash.
* Long options are prefixed by two consecutive dashes. *
* </para></listitem><listitem><para> * - Long options are prefixed by two consecutive dashes.
* Options can have an extra argument, which can be a number, a string or *
* - 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 * 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 * 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 * argument starts with a dash, which would otherwise cause it to be
* interpreted as another option. * interpreted as another option.
* </para></listitem><listitem><para> *
* Non-option arguments are returned to the application as rest arguments. * - Non-option arguments are returned to the application as rest arguments.
* </para></listitem><listitem><para> *
* An argument consisting solely of two dashes turns off further parsing, * - An argument consisting solely of two dashes turns off further parsing,
* any remaining arguments (even those starting with a dash) are returned * any remaining arguments (even those starting with a dash) are returned
* to the application as rest arguments. * to the application as rest arguments.
* </para></listitem></itemizedlist>
* *
* Another important feature of GOption is that it can automatically * Another important feature of GOption is that it can automatically
* generate nicely formatted help output. Unless it is explicitly turned * generate nicely formatted help output. Unless it is explicitly turned