From 5e5547045ba347e8c4e7b327ebd402ab6b0e3497 Mon Sep 17 00:00:00 2001 From: Reid Spencer Date: Tue, 16 Nov 2004 06:11:52 +0000 Subject: Per code review: *Implement/Document the cl::extrahelp feature instead of the MoreHelp ptr. llvm-svn: 17871 --- llvm/docs/CommandLine.html | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) (limited to 'llvm/docs') diff --git a/llvm/docs/CommandLine.html b/llvm/docs/CommandLine.html index 531c0f899c9..c5fa4d36f1e 100644 --- a/llvm/docs/CommandLine.html +++ b/llvm/docs/CommandLine.html @@ -2,6 +2,7 @@ "http://www.w3.org/TR/html4/strict.dtd"> + CommandLine 2.0 Library Manual @@ -61,6 +62,7 @@
  • The cl::opt class
  • The cl::list class
  • The cl::alias class
    • +
  • The cl::extrahelp class
  • Builtin parsers @@ -1519,6 +1521,34 @@ the conversion from string to data.

    + +
    + The cl::extrahelp class +
    + +
    + +

    The cl::extrahelp class is a nontemplated class that allows extra +help text to be printed out for the --help option.

    + +
    +namespace cl {
+  struct extrahelp;
+}
+
    + +

    To use the extrahelp, simply construct one with a const char* +parameter to the constructor. The text passed to the constructor will be printed +at the bottom of the help message, verbatim. Note that multiple +cl::extrahelp can be used but this practice is discouraged. If +your tool needs to print additional help information, put all that help into a +single cl::extrahelp instance.

    +

    For example:

    +
    +  cl::extrahelp("\nADDITIONAL HELP:\n\n  This is the extra help\n");
+
    +
    +
    Builtin parsers -- cgit v1.2.3