diff options
| author | Boris Kolpackov <boris@codesynthesis.com> | 2012-06-03 11:26:30 +0200 |
|---|---|---|
| committer | Boris Kolpackov <boris@codesynthesis.com> | 2012-06-03 11:26:30 +0200 |
| commit | 4c776f3cb590bf031d6288043c530679a207a0c0 (patch) | |
| tree | c46dad9f7374722b472fe631031c92a4e756eb79 /doc/cli.xhtml | |
| parent | f0fe82442f2ab1ca7745d983f828aba0734255aa (diff) | |
Documentation update
Diffstat (limited to 'doc/cli.xhtml')
| -rw-r--r-- | doc/cli.xhtml | 11 |
1 files changed, 7 insertions, 4 deletions
diff --git a/doc/cli.xhtml b/doc/cli.xhtml index 1ac88b0..13ef998 100644 --- a/doc/cli.xhtml +++ b/doc/cli.xhtml @@ -91,7 +91,7 @@ <dd>Print version and exit.</dd> <dt><code><b>--include-path</b></code>|<code><b>-I</b></code> <i>dir</i></dt> - <dd>Search <i>dir</i> for bracket-included (<code><b><></b></code>) option + <dd>Search <i>dir</i> for bracket-included (<code><b><></b></code>) options files.</dd> <dt><code><b>--output-dir</b></code>|<code><b>-o</b></code> <i>dir</i></dt> @@ -167,9 +167,12 @@ <dt><code><b>--class</b></code> <i>fq-name</i></dt> <dd>Generate the man page or HTML documentation only for the <i>fq-name</i> options class. The <i>fq-name</i> name should be a fully-qualified options - class name, for example, <code><b>app::options</b></code>. This - functionality is useful if you need to insert custom documentation between - options belonging to different classes.</dd> + class name, for example, <code><b>app::options</b></code>. To generate + documentation for multiple classes, repeat this option and the documentation + will be produced in the order specified. This functionality is useful if you + need to assemble documentation from multiple classes in a specific order or + to insert custom documentation between options belonging to different + classes.</dd> <dt><code><b>--stdout</b></code></dt> <dd>Write output to STDOUT instead of a file. This option is not valid when |