Changeset 1437 for trunk/yat/utility/OptionHelp.h

Timestamp:

Aug 25, 2008, 7:55:00 PM (14 years ago)

Author:

Peter

Message:

merge patch release 0.4.2 to trunk. Delta 0.4.2-0.4.1

File:

• trunk/yat/utility/OptionHelp.h (modified) (2 diffs)

trunk/yat/utility/OptionHelp.h

@@ -8 +8 @@
   Copyright (C) 2008 Peter Johansson
 
-  This file is part of the yat library, http://trac.thep.lu.se/yat
+  This file is part of the yat library, http://dev.thep.lu.se/yat
 
   The yat library is free software; you can redistribute it and/or
@@ -39 +39 @@
 
      When this option is found in parsing of commandline, it displays
-     a help output exits.
+     a help output and exits. A typical output looks like:
+
+     \verbatim
+     Usage: foo [OPTION]...
+
+     SYNOPSIS
+
+     Available options are:
+     -h, --help      display this help and exit
+     -v, --verbose   explain what is being done
+
+     Some extra information explaining something.
+     \endverbatim
+
+     The output consist of four blocks. The first block can be
+     modified with usage(void) function. The second is block is
+     typically a one-liner explaining the application and can be
+     modified with the synopsis(void) function. The third block
+     contain the description of the different options, see
+     operator<<(std::ostream&, const CommandLine&) for further
+     details. The last block can be modified with post_arguments(void)
+     function.
    */
   class OptionHelp : public OptionSwitch