summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorBoris Kolpackov <boris@codesynthesis.com>2015-11-24 14:30:02 +0200
committerBoris Kolpackov <boris@codesynthesis.com>2015-11-24 14:30:02 +0200
commitb8b194ea5fa6ba7a3aac7ff212eb62ccfb942dbf (patch)
tree5d31eafd8e0fcfe497bd8fd022370966f0a26f76 /doc
parent469605e872aeca50c7556708de5d50d7e7935d83 (diff)
Implement --class-doc option
Diffstat (limited to 'doc')
-rw-r--r--doc/cli.118
-rw-r--r--doc/cli.xhtml31
2 files changed, 36 insertions, 13 deletions
diff --git a/doc/cli.1 b/doc/cli.1
index 1a89aed..57fd6c2 100644
--- a/doc/cli.1
+++ b/doc/cli.1
@@ -149,10 +149,20 @@ Exclude base class information from usage and documentation\.
.IP "\fB--include-base-last\fR"
Include base class information after derived for usage and documentation\. By
default, base classes are included first\.
-.IP "\fB--class\fR \fIfq-name\fR"
-Generate the man page or HTML documentation only for the \fIfq-name\fR options
-class\. The \fIfq-name\fR name should be a fully-qualified options class name,
-for example, \fBapp::options\fR\. To generate documentation for multiple
+.IP "\fB--class-doc\fR \fIname\fR=\fIkind\fR"
+Specify the documentation \fIkind\fR that should be used for the options class
+\fIname\fR\. The \fIname\fR value should be a fully-qualified class name, for
+example, \fBapp::options\fR\. The \fIkind\fR value can be \fBshort\fR,
+\fBlong\fR, or \fBexclude\fR\. If the value is \fBexclude\fR, then the class
+documentation is excluded from usage and man/HTML output\. For usage, the
+\fBshort\fR and \fBlong\fR values determine which usage function will be
+called when the class is used as base or as part of the page usage (see
+\fB--page-usage\fR)\. For man/HTML, these values determine which documentation
+strings are used in the output\.
+.IP "\fB--class\fR \fIname\fR"
+Generate the man page or HTML documentation only for the options class
+\fIname\fR\. The \fIname\fR value should be a fully-qualified options class
+name, for example, \fBapp::options\fR\. 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
diff --git a/doc/cli.xhtml b/doc/cli.xhtml
index 4d80b83..962d53b 100644
--- a/doc/cli.xhtml
+++ b/doc/cli.xhtml
@@ -197,15 +197,28 @@
<dd>Include base class information after derived for usage and
documentation. By default, base classes are included first.</dd>
- <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>. 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>--class-doc</b></code> <i>name</i>=<i>kind</i></dt>
+ <dd>Specify the documentation <i>kind</i> that should be used for the
+ options class <i>name</i>. The <i>name</i> value should be a
+ fully-qualified class name, for example, <code><b>app::options</b></code>.
+ The <i>kind</i> value can be <code><b>short</b></code>,
+ <code><b>long</b></code>, or <code><b>exclude</b></code>. If the value is
+ <code><b>exclude</b></code>, then the class documentation is excluded from
+ usage and man/HTML output. For usage, the <code><b>short</b></code> and
+ <code><b>long</b></code> values determine which usage function will be
+ called when the class is used as base or as part of the page usage (see
+ <code><b>--page-usage</b></code>). For man/HTML, these values determine
+ which documentation strings are used in the output.</dd>
+
+ <dt><code><b>--class</b></code> <i>name</i></dt>
+ <dd>Generate the man page or HTML documentation only for the options class
+ <i>name</i>. The <i>name</i> value should be a fully-qualified options
+ 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>--docvar</b></code>|<code><b>-v</b></code> <i>name</i>=<i>val</i></dt>
<dd>Set documentation variable <i>name</i> to the value <i>val</i>.