diff options
Diffstat (limited to 'cli/options.cli')
-rw-r--r-- | cli/options.cli | 87 |
1 files changed, 49 insertions, 38 deletions
diff --git a/cli/options.cli b/cli/options.cli index 7f8e2dc..841081d 100644 --- a/cli/options.cli +++ b/cli/options.cli @@ -65,6 +65,15 @@ class options made inline. This option suppresses creation of the inline file." }; + std::string --cli-namespace = "::cli" + { + "<ns>", + "Generate the CLI support types in the <ns> namespace (\cb{cli} by + default). The namespace can be nested, for example \cb{details::cli}. + If the namespace is empty, then the support types are generated in + the global namespace." + }; + std::string --ostream-type = "::std::ostream" { "<type>", @@ -72,6 +81,29 @@ class options should be used to print usage and exception information." }; + bool --generate-cxx + { + "Generate C++ code. If neither \cb{--generate-man} nor \cb{--generate-html} + is specified, this mode is assumed by default." + }; + + bool --generate-man + { + "Generate documentation in the man page format." + }; + + bool --generate-html + { + "Generate documentation in the HTML format." + }; + + bool --stdout + { + "Write output to STDOUT instead of a file. This option is not valid + when generating C++ code and is normally used to combine generated + documentation for several option classes in a single file." + }; + bool --suppress-undocumented { "Suppress the generation of documentation entries for undocumented @@ -112,29 +144,27 @@ class options "Exclude base class information from usage and documentation." }; - std::string --cli-namespace = "::cli" - { - "<ns>", - "Generate the CLI support types in the <ns> namespace (\cb{cli} by - default). The namespace can be nested, for example \cb{details::cli}. - If the namespace is empty, then the support types are generated in - the global namespace." - }; - - bool --generate-cxx - { - "Generate C++ code. If neither \cb{--generate-man} nor \cb{--generate-html} - is specified, this mode is assumed by default." - }; - - bool --generate-man + std::vector<std::string> --class { - "Generate documentation in the man page format." + "<fq-name>", + "Generate the man page or HTML documentation only for the <fq-name> options + class. The <fq-name> name should be a fully-qualified options class name, + for example, \cb{app::options}. 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." }; - bool --generate-html + std::map<std::string, std::string> --docvar|-v { - "Generate documentation in the HTML format." + "<name>=<val>", + "Set documentation variable <name> to the value <val>. Documentation + variables can be substituted in prologues and epilogues (see + \cb{--*-prologue*} and \cb{--*-epilogue*} options) using the + \cb{$}<name>\cb{$} expansion syntax (use \cb{$$} to escape expansion). + They can also be defined in \cb{.cli} files using the + \c{\"\\<name>=<val>\"} syntax." }; // Prologues. @@ -273,25 +303,6 @@ class options "Insert the content of <file> at the end of the generated HTML file." }; - std::vector<std::string> --class - { - "<fq-name>", - "Generate the man page or HTML documentation only for the <fq-name> options - class. The <fq-name> name should be a fully-qualified options class name, - for example, \cb{app::options}. 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." - }; - - bool --stdout - { - "Write output to STDOUT instead of a file. This option is not valid - when generating C++ code and is normally used to combine generated - documentation for several option classes in a single file." - }; - std::string --hxx-suffix = ".hxx" { "<suffix>", |