From 4c776f3cb590bf031d6288043c530679a207a0c0 Mon Sep 17 00:00:00 2001
From: Boris Kolpackov <boris@codesynthesis.com>
Date: Sun, 3 Jun 2012 11:26:30 +0200
Subject: Documentation update

---
 doc/cli.1     | 10 ++++++----
 doc/cli.xhtml | 11 +++++++----
 2 files changed, 13 insertions(+), 8 deletions(-)

(limited to 'doc')

diff --git a/doc/cli.1 b/doc/cli.1
index 4794ec8..1952e24 100644
--- a/doc/cli.1
+++ b/doc/cli.1
@@ -68,7 +68,7 @@ Print usage information and exit\.
 Print version and exit\.
 
 .IP "\fB--include-path\fP|\fB-I\fP \fIdir\fP"
-Search \fIdir\fP for bracket-included (\fB<>\fP) option files\.
+Search \fIdir\fP for bracket-included (\fB<>\fP) options files\.
 
 .IP "\fB--output-dir\fP|\fB-o\fP \fIdir\fP"
 Write the generated files to \fIdir\fP instead of the current directory\.
@@ -142,9 +142,11 @@ Insert the content of \fIfile\fP at the end of the HTML file\.
 .IP "\fB--class\fP \fIfq-name\fP"
 Generate the man page or HTML documentation only for the \fIfq-name\fP
 options class\. The \fIfq-name\fP name should be a fully-qualified options
-class name, for example, \fBapp::options\fP\. This functionality is useful
-if you need to insert custom documentation between options belonging to
-different classes\.
+class name, for example, \fBapp::options\fP\. 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\.
 
 .IP "\fB--stdout\fP"
 Write output to STDOUT instead of a file\. This option is not valid when
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>&lt;></b></code>) option
+  <dd>Search <i>dir</i> for bracket-included (<code><b>&lt;></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
-- 
cgit v1.1