diff options
| author | Reid Spencer <rspencer@reidspencer.com> | 2004-11-16 06:11:52 +0000 |
|---|---|---|
| committer | Reid Spencer <rspencer@reidspencer.com> | 2004-11-16 06:11:52 +0000 |
| commit | 9bbba091396922093687d11a181e5886c42c5dfd (patch) | |
| tree | d7c9f33e6fe941c0d335160a75ed88187a7661cb /docs | |
| parent | eea9b134fcd97aa6c11277864fecf2d30640d27f (diff) | |
| download | llvm-9bbba091396922093687d11a181e5886c42c5dfd.tar.gz llvm-9bbba091396922093687d11a181e5886c42c5dfd.tar.bz2 llvm-9bbba091396922093687d11a181e5886c42c5dfd.tar.xz | |
Per code review:
*Implement/Document the cl::extrahelp feature instead of the MoreHelp ptr.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@17871 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/CommandLine.html | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/docs/CommandLine.html b/docs/CommandLine.html index 531c0f899c..c5fa4d36f1 100644 --- a/docs/CommandLine.html +++ b/docs/CommandLine.html @@ -2,6 +2,7 @@ "http://www.w3.org/TR/html4/strict.dtd"> <html> <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <title>CommandLine 2.0 Library Manual</title> <link rel="stylesheet" href="llvm.css" type="text/css"> </head> @@ -61,6 +62,7 @@ <li><a href="#cl::opt">The <tt>cl::opt</tt> class</a></li> <li><a href="#cl::list">The <tt>cl::list</tt> class</a></li> <li><a href="#cl::alias">The <tt>cl::alias</tt> class</a></li> + <li><a href="#cl::extrahelp">The <tt>cl::extrahelp</tt> class</a></li> </ul></li> <li><a href="#builtinparsers">Builtin parsers</a> @@ -1519,6 +1521,34 @@ the conversion from string to data.</p> </div> +<!-- _______________________________________________________________________ --> +<div class="doc_subsubsection"> + <a name="cl::extrahelp">The <tt>cl::extrahelp</tt> class</a> +</div> + +<div class="doc_text"> + +<p>The <tt>cl::extrahelp</tt> class is a nontemplated class that allows extra +help text to be printed out for the <tt>--help</tt> option.</p> + +<pre> +<b>namespace</b> cl { + <b>struct</b> extrahelp; +} +</pre> + +<p>To use the extrahelp, simply construct one with a <tt>const char*</tt> +parameter to the constructor. The text passed to the constructor will be printed +at the bottom of the help message, verbatim. Note that multiple +<tt>cl::extrahelp</tt> <b>can</b> be used but this practice is discouraged. If +your tool needs to print additional help information, put all that help into a +single <tt>cl::extrahelp</tt> instance.</p> +<p>For example:</p> +<pre> + cl::extrahelp("\nADDITIONAL HELP:\n\n This is the extra help\n"); +</pre> +</div> + <!-- ======================================================================= --> <div class="doc_subsection"> <a name="builtinparsers">Builtin parsers</a> |