Changeset 602

Timestamp:

Aug 29, 2006, 5:10:05 AM (15 years ago)

Author:

Peter

Message:

closes #99 documentation on CommandLine? class

File:

• trunk/c++_tools/utility/CommandLine.h (modified) (5 diffs)

trunk/c++_tools/utility/CommandLine.h

@@ -36 +36 @@
 namespace utility {
 
-  ///
-  /// @brief Class for parsing the command line.
-  ///
-  /// @see Option
-  ///
+  /**
+     @brief Class for parsing the command line.
+     
+     Provides parsing and storage of command line arguments (argc,
+     argv). To use this class first add a set of valid parameters
+     using the add_parameter() function. Each parameter is associated
+     to a one-character flag and/or a longer string flag. The longer
+     flag expects to be preceded by '--' as e.g. '--help' for
+     help. The shorter flag expects to be preceded by '-' as
+     e.g. '-h', and can also be concatenated as e.g. "program -vf" is
+     equivalent to "program -v -f". Associated to each parameter is an
+     attribute telling what type of argument is expected for the
+     parameter. Several types of arguments are supported: no argument,
+     string argument, int argument, double argument. The argument
+     value for all found parameters are set during parsing, which
+     supports both gnu-style "--support-gnu=value", POSIX-like
+     "--support-posix value", as well as shorter "-s value". The
+     argument of an parameter is retrived by the value() function or
+     its sibblings for different types. By using the set_help()
+     function help will be displayed when flag (default is '-h' and
+     '--help') is found in parsing.
+     
+     Here is a small code example:
+     @code 
+#include <c++_tools/utility/CommandLine.h> 
+#include <iostream>
+int main(const int argc,const char* argv[])
+{
+  theplu::utility::CommandLine cmd;
+  cmd.set_general_description("This is just an example program");
+  cmd.add_parameter('n', utility::Option::int_arg, 
+                    "example of parameter taking an integer");
+  cmd.add_parameter('t', "target", utility::Option::string_arg);
+  cmd.add_parameter("version",utility::Option::no_arg, 
+                    "output version infomation and exit");
+  cmd.set_help();
+  cmd.parse(argc, argv);
+  if (cmd.present("version"))
+    std::cout << "example 1.0" << std::endl;
+  if (cmd.present("target"))
+    std::cout << "using target: " << target << std::endl;
+  if (cmd.present('n')){
+    int n=cmd.value('n');
+    for (size_t i=0; i<n; ++i)
+      std::cout << "Hello World\n";
+    std::cout << endl;
+  }
+  return 0;
+}
+     @endcode 
+     
+     @see Option
+     
+  **/
   class CommandLine
   {
@@ -59 +108 @@
     ///
     /// @param long_name string key such as "help" for --help flag
-    /// @param telling what kind argument this option expects
+    /// @param arg telling what kind argument this option expects
     /// @param description string used in help display
     ///
@@ -70 +119 @@
     ///
     /// @param short_name one character key such as 'h' for -h flag
-    /// @param telling what kind argument this option expects
+    /// @param arg telling what kind argument this option expects
     /// @param description string used in help display
     ///
@@ -82 +131 @@
     /// @param short_name one character key such as 'h' for -h flag
     /// @param long_name string key such as "help" for --help flag
-    /// @param telling what kind argument this option expects
+    /// @param arg telling what kind argument this option expects
     /// @param description string used in help display
     ///
@@ -162 +211 @@
     /// will cause an error message and exit.
     ///
-    /// @todo doc
+    /// @return argument value for @a parameter 
     ///
     int value_int(const std::string& parameter) const;