From a376ccf37122f0768fce8e3c5a16561e01ee2351 Mon Sep 17 00:00:00 2001 From: Boris Kolpackov Date: Sun, 22 Nov 2009 16:58:56 +0200 Subject: Implement option value modifiers generation --- doc/guide/index.xhtml | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) (limited to 'doc/guide') 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:

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 print_usage() function that - can be used to print the usage information for the options + accessor functions and, if the --generate-modifier CLI + compiler option is specified, modifier functions corresponding to option + definitions. It also defines a public static print_usage() + function that can be used to print the usage information for the options defined by the class.

The argc/argv arguments in the overloaded constructors @@ -779,11 +780,11 @@ namespace cli

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 |. The C++ accessor function name is derived from the - first name by removing any leading special characters, such as - -, /, etc., and replacing special characters - in other places with underscores. For example, the following option - definition:

+ by |. The C++ accessor and modifier function names are + derived from the first name by removing any leading special characters, + such as -, /, etc., and replacing special + characters in other places with underscores. For example, the following + option definition:

 class options
-- 
cgit v1.1