diff options
author | Boris Kolpackov <boris@codesynthesis.com> | 2018-03-19 12:44:04 +0200 |
---|---|---|
committer | Boris Kolpackov <boris@codesynthesis.com> | 2018-03-19 12:44:04 +0200 |
commit | 1dea398d6f864c99b9e1c34e4a718239cfd3d8ac (patch) | |
tree | 0515378ce75266616760ff41d979357c56d2a087 /cli/options.cli | |
parent | 29e274022a8c88dd1a48c1b591635bb044fe808f (diff) | |
download | cli-1dea398d6f864c99b9e1c34e4a718239cfd3d8ac.tar.gz cli-1dea398d6f864c99b9e1c34e4a718239cfd3d8ac.tar.xz cli-1dea398d6f864c99b9e1c34e4a718239cfd3d8ac.zip |
Add support for exclude-base value in --class-doc option
Diffstat (limited to 'cli/options.cli')
-rw-r--r-- | cli/options.cli | 20 |
1 files changed, 11 insertions, 9 deletions
diff --git a/cli/options.cli b/cli/options.cli index cd644f3..ffa0e5d 100644 --- a/cli/options.cli +++ b/cli/options.cli @@ -213,15 +213,17 @@ class options std::map<std::string, std::string> --class-doc { "<name>=<kind>", - "Specify the documentation <kind> that should be used for the options - class <name>. The <name> value should be a fully-qualified class name, - for example, \cb{app::options}. The <kind> value can be \cb{short}, - \cb{long}, or \cb{exclude}. If the value is \cb{exclude}, then the - class documentation is excluded from usage and man/HTML/text output. For - usage, the \cb{short} and \cb{long} values determine which usage - function will be called when the class is used as base or as part of - the page usage (see \cb{--page-usage}). For man/HTML/text, these values - determine which documentation strings are used in the output." + "Specify the documentation <kind> that should be used for the options class + <name>. The <name> value should be a fully-qualified class name, for + example, \cb{app::options}. The <kind> value can be \cb{short}, + \cb{long}, \cb{exclude}, or \cb{exclude-base}. If the value is + \cb{exclude}, then the class documentation is excluded from usage and + man/HTML/text output. If it is \cb{exclude-base}, then it is only + excluded when used as a base. For usage, the \cb{short} and \cb{long} + values determine which usage function will be called when the class is + used as base or as part of the page usage (see \cb{--page-usage}). For + man/HTML/text, these values determine which documentation strings are + used in the output." }; std::vector<std::string> --class |