From a376ccf37122f0768fce8e3c5a16561e01ee2351 Mon Sep 17 00:00:00 2001
From: Boris Kolpackov <boris@codesynthesis.com>
Date: Sun, 22 Nov 2009 16:58:56 +0200
Subject: Implement option value modifiers generation

---
 doc/cli.1             |  3 +++
 doc/cli.xhtml         |  3 +++
 doc/guide/index.xhtml | 17 +++++++++--------
 3 files changed, 15 insertions(+), 8 deletions(-)

(limited to 'doc')

diff --git a/doc/cli.1 b/doc/cli.1
index 2e9f180..7c89ace 100644
--- a/doc/cli.1
+++ b/doc/cli.1
@@ -70,6 +70,9 @@ Print version and exit\.
 .IP "\fB--output-dir\fP|\fB-o\fP \fIdir\fP"
 Write the generated files to \fIdir\fP instead of the current directory\.
 
+.IP "\fB--generate-modifier\fP"
+Generate option value modifiers in addition to accessors\.
+
 .IP "\fB--suppress-inline\fP"
 Generate all functions non-inline\. By default simple functions are made
 inline\. This option suppresses creation of the inline file\.
diff --git a/doc/cli.xhtml b/doc/cli.xhtml
index 85dd4b9..e431f97 100644
--- a/doc/cli.xhtml
+++ b/doc/cli.xhtml
@@ -93,6 +93,9 @@
   <dt><code><b>--output-dir</b></code>|<code><b>-o</b></code> <i>dir</i></dt>
   <dd>Write the generated files to <i>dir</i> instead of the current directory.</dd>
 
+  <dt><code><b>--generate-modifier</b></code></dt>
+  <dd>Generate option value modifiers in addition to accessors.</dd>
+
   <dt><code><b>--suppress-inline</b></code></dt>
   <dd>Generate all functions non-inline. By default simple functions are made
   inline. This option suppresses creation of the inline file.</dd>
diff --git a/doc/guide/index.xhtml b/doc/guide/index.xhtml
index a7ae6e7..89f56e7 100644
--- a/doc/guide/index.xhtml
+++ b/doc/guide/index.xhtml
@@ -607,9 +607,10 @@ public:
   <p>An option class is mapped to a C++ class with the same name. The
      C++ class defines a set of public overloaded constructors, a public
      copy constructor and an assignment operator, as well as a set of public
-     accessor functions corresponding to option definitions. It also
-     defines a public static <code>print_usage()</code> function that
-     can be used to print the usage information for the options
+     accessor functions and, if the <code>--generate-modifier</code> CLI
+     compiler option is specified, modifier functions corresponding to option
+     definitions. It also defines a public static <code>print_usage()</code>
+     function that can be used to print the usage information for the options
      defined by the class.</p>
 
   <p>The <code>argc/argv</code> arguments in the overloaded constructors
@@ -779,11 +780,11 @@ namespace cli
 
 <p>The name component specifies the option name as it will be entered
    in the command line. A name can contain any number of aliases separated
-   by <code>|</code>. The C++ accessor function name is derived from the
-   first name by removing any leading special characters, such as
-   <code>-</code>, <code>/</code>, etc., and replacing special characters
-   in other places with underscores. For example, the following option
-   definition:</p>
+   by <code>|</code>. The C++ accessor and modifier function names are
+   derived from the first name by removing any leading special characters,
+   such as <code>-</code>, <code>/</code>, etc., and replacing special
+   characters in other places with underscores. For example, the following
+   option definition:</p>
 
   <pre>
 class options
-- 
cgit v1.1