Ticket #104: arg_parser_doc_eea4295af4ad.patch

demo/arg_parser_demo.cc

@@ -29 +29 @@
 using namespace lemon;
 int main(int argc, const char **argv)
 {
+  // Initialize the argument parser and set all options.
   ArgParser ap(argc,argv);
   int i;
   std::string s;
-  double d;
-  bool b,sil;
+  double d=1.0;
+  bool b,nh;
   bool g1,g2,g3;
-  ap.refOption("n", "An integer input.", i, true)
-    .refOption("val", "A double input.", d)
-    .doubleOption("val2", "A double input.", d)
-    .synonym("vals","val")
-    .refOption("name", "A string input.", s)
+  ap.refOption("n", "An integer input.", i, true)       // mandatory integer option with storage reference
+    .refOption("val", "A double input.", d)             // double option with storage reference (default value: 1.0)
+    .doubleOption("val2", "A double input.", 3.14)      // double option without storage reference (default value: 3.14)
+    .synonym("vals","val")                              // synonym for -val option
+    .refOption("name", "A string input.", s)            // string option
     .refOption("f", "A switch.", b)
-    .refOption("nohelp", "", sil)
+    .refOption("nohelp", "", nh)
     .refOption("gra","Choice A",g1)
     .refOption("grb","Choice B",g2)
-    .refOption("grc","Choice C",g3)
+    .refOption("grc","Choice C",g3)                     // bool options
     .optionGroup("gr","gra")
     .optionGroup("gr","grb")
-    .optionGroup("gr","grc")
-    .mandatoryGroup("gr")
-    .onlyOneGroup("gr")
+    .optionGroup("gr","grc")                            // bundle -gr* options into a group
+    .mandatoryGroup("gr")                               // the group is mandatory
+    .onlyOneGroup("gr")                                 // only one option can be given from the group
     .other("infile","The input file.")
-    .other("...");
+    .other("...");                                      // non-parsed arguments (e.g. input files)
   
+  // Perform the parsing process. In case of any error it terminates the program. 
   ap.parse();
 
+  // Check each option if it has been given and print its value.
   std::cout << "Parameters of '" << ap.commandName() << "':\n";
 
-  if(ap.given("n")) std::cout << "  Value of -n: " << i << std::endl;
+  std::cout << "  Value of -n: " << i << std::endl;
   if(ap.given("val")) std::cout << "  Value of -val: " << d << std::endl;
+  if(ap.given("val2")) {
+    d = ap["val2"];
+    std::cout << "  Value of -val2: " << d << std::endl;
+  }
   if(ap.given("name")) std::cout << "  Value of -name: " << s << std::endl;
   if(ap.given("f")) std::cout << "  -f is given\n";
-  if(ap.given("nohelp")) std::cout << "  Value of -nohelp: " << sil << std::endl;
+  if(ap.given("nohelp")) std::cout << "  Value of -nohelp: " << nh << std::endl;
   if(ap.given("gra")) std::cout << "  -gra is given\n";
   if(ap.given("grb")) std::cout << "  -grb is given\n";
   if(ap.given("grc")) std::cout << "  -grc is given\n";
@@ -80 +87 @@
   for(unsigned int i=0;i<ap.files().size();++i)
     std::cout << "    '" << ap.files()[i] << "'\n";
   
+  return 0;  
 }

lemon/arg_parser.h

@@ -118 +118 @@
     
   public:
 
-    ///\e
+    ///Constructor
     ArgParser(int argc, const char **argv);
 
     ~ArgParser();
 
+    ///\name Options
+    ///
+
+    ///@{
+
     ///Add a new integer type option
 
+    ///Add a new integer type option.
     ///\param name The name of the option. The leading '-' must be omitted.
     ///\param help A help string.
     ///\param value A default value for the option.
@@ -135 +141 @@
 
     ///Add a new floating point type option
 
+    ///Add a new floating point type option.
     ///\param name The name of the option. The leading '-' must be omitted.
     ///\param help A help string.
     ///\param value A default value for the option.
@@ -145 +152 @@
 
     ///Add a new bool type option
 
+    ///Add a new bool type option.
     ///\param name The name of the option. The leading '-' must be omitted.
     ///\param help A help string.
     ///\param value A default value for the option.
@@ -156 +164 @@
 
     ///Add a new string type option
 
+    ///Add a new string type option.
     ///\param name The name of the option. The leading '-' must be omitted.
     ///\param help A help string.
     ///\param value A default value for the option.
@@ -164 +173 @@
                       const std::string &help,
                       std::string value="", bool obl=false);
 
-    ///\name Options with external storage
+    ///Give help string for non-parsed arguments.
+
+    ///With this function you can give help string for non-parsed arguments.
+    ///The parameter \c name will be printed in the short usage line, while
+    ///\c help gives a more detailed description.
+    ArgParser &other(const std::string &name,
+                     const std::string &help="");
+    
+    ///@}
+
+    ///\name Options with External Storage
     ///Using this functions, the value of the option will be directly written
     ///into a variable once the option appears in the command line.
 
@@ -172 +191 @@
 
     ///Add a new integer type option with a storage reference
 
+    ///Add a new integer type option with a storage reference.
     ///\param name The name of the option. The leading '-' must be omitted.
     ///\param help A help string.
     ///\param obl Indicate if the option is mandatory.
@@ -182 +202 @@
 
     ///Add a new floating type option with a storage reference
 
+    ///Add a new floating type option with a storage reference.
     ///\param name The name of the option. The leading '-' must be omitted.
     ///\param help A help string.
     ///\param obl Indicate if the option is mandatory.
@@ -192 +213 @@
 
     ///Add a new bool type option with a storage reference
 
+    ///Add a new bool type option with a storage reference.
     ///\param name The name of the option. The leading '-' must be omitted.
     ///\param help A help string.
     ///\param obl Indicate if the option is mandatory.
@@ -203 +225 @@
 
     ///Add a new string type option with a storage reference
 
+    ///Add a new string type option with a storage reference.
     ///\param name The name of the option. The leading '-' must be omitted.
     ///\param help A help string.
     ///\param obl Indicate if the option is mandatory.
@@ -218 +241 @@
     
     ///@{
 
-    ///Boundle some options into a group
+    ///Bundle some options into a group
 
     /// You can group some option by calling this function repeatedly for each
     /// option to be grouped with the same groupname.
@@ -230 +253 @@
     ///Make the members of a group exclusive
 
     ///If you call this function for a group, than at most one of them can be
-    ///given at the same time
+    ///given at the same time.
     ArgParser &onlyOneGroup(const std::string &group);
   
     ///Make a group mandatory
@@ -247 +270 @@
                            const std::string &opt);
     
     ///@}
-
-    ///Give help string for non-parsed arguments.
-
-    ///With this function you can give help string for non-parsed arguments.
-    ///The parameter \c name will be printed in the short usage line, while
-    ///\c help gives a more detailed description.
-    ArgParser &other(const std::string &name,
-                     const std::string &help="");
-    
-    ///Give back the non-option type arguments.
-
-    ///Give back a reference to a vector consisting of the program arguments
-    ///not starting with a '-' character.
-    std::vector<std::string> &files() { return _file_args; }
-
-    ///Give back the command name (the 0th argument)
-    const std::string &commandName() { return _command_name; }
 
     void show(std::ostream &os,Opts::iterator i);
     void show(std::ostream &os,Groups::iterator i);
@@ -286 +292 @@
       return parse();
     }
     
+    ///Give back the command name (the 0th argument)
+    const std::string &commandName() { return _command_name; }
+
     ///Check if an opion has been given to the command.
     bool given(std::string op) 
     {
@@ -360 +369 @@
     {
       return RefType(*this, n);
     }    
+
+    ///Give back the non-option type arguments.
+
+    ///Give back a reference to a vector consisting of the program arguments
+    ///not starting with a '-' character.
+    std::vector<std::string> &files() { return _file_args; }
  
   };
 }
 
-    
-
-#endif // LEMON_MAIN_PARAMS
+#endif // LEMON_ARG_PARSER