Changeset 88:18444049848b in lemon-main

Timestamp:

03/16/08 01:39:19 (17 years ago)

Author:

Peter Kovacs <kpeter@…>

Branch:

default

Phase:

public

Message:

Minor improvements in arg_parser files

Files:

• demo/arg_parser_demo.cc (modified) (4 diffs)
• lemon/arg_parser.cc (modified) (2 diffs)
• lemon/arg_parser.h (modified) (8 diffs)

demo/arg_parser_demo.cc

@@ -21 +21 @@
 ///\brief Argument parser demo
 ///
-/// This example shows how can the argument parser used.
+/// This example shows how the argument parser can be used.
 ///
-/// \include arg_parser.cc
+/// \include arg_parser_demo.cc
 
 #include <lemon/arg_parser.h>
@@ -36 +36 @@
   bool b,sil;
   bool g1,g2,g3;
-  ap.refOption("n", "an integer input", i, true)
-    .refOption("val", "a double input", d)
+  ap.refOption("n", "An integer input.", i, true)
+    .refOption("val", "A double input.", d)
     .synonym("vals","val")
-    .refOption("name", "a string input", s)
-    .refOption("f", "a switch", b)
+    .refOption("name", "A string input.", s)
+    .refOption("f", "A switch.", b)
     .refOption("nohelp", "", sil)
-    .refOption("gra","Choise A",g1)
-    .refOption("grb","Choise B",g2)
-    .refOption("grc","Choise C",g3)
+    .refOption("gra","Choice A",g1)
+    .refOption("grb","Choice B",g2)
+    .refOption("grc","Choice C",g3)
     .optionGroup("gr","gra")
     .optionGroup("gr","grb")
@@ -50 +50 @@
     .mandatoryGroup("gr")
     .onlyOneGroup("gr")
-    .other("infile","The input file")
+    .other("infile","The input file.")
     .other("...");
   
@@ -62 +62 @@
   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("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";
+                                     
   switch(ap.files().size()) {
   case 0:

lemon/arg_parser.cc

@@ -70 +70 @@
     p.type=INTEGER;
     p.mandatory=obl;
-    p.self_delete=true;
     _opts[name]=p;
     return *this;
@@ -100 +99 @@
     p.mandatory=obl;
     _opts[name]=p;
-
-    value = false;
-
     return *this;
   }

lemon/arg_parser.h

@@ -31 +31 @@
 ///\ingroup misc
 ///\file
-///\brief A tools to parse command line arguments.
-///
-///\author Alpar Juttner
+///\brief A tool to parse command line arguments.
 
 namespace lemon {
@@ -40 +38 @@
 
   ///\ingroup misc
-  ///Command line arguments parser
+  ///Command line arguments parser.
   ///
+  ///For a complete example see the \ref arg_parser_demo.cc demo file.
   class ArgParser {
     
@@ -166 +165 @@
                       std::string value="", bool obl=false);
 
-    ///\name Options with an external strorage.
+    ///\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.
@@ -223 +222 @@
 
     /// You can group some option by calling this function repeatedly for each
-    /// option to be grupped with the same groupname.
-    ///\param group The group name
-    ///\param opt The option name
+    /// option to be grouped with the same groupname.
+    ///\param group The group name.
+    ///\param opt The option name.
     ArgParser &optionGroup(const std::string &group,
                            const std::string &opt);
@@ -243 +242 @@
     ///Create synonym to an option
 
-    ///With this function you can create a sysnonym called \c sys of the
+    ///With this function you can create a synonym \c syn of the
     ///option \c opt.
     ArgParser &synonym(const std::string &syn,
@@ -253 +252 @@
 
     ///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
+    ///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="");
     
-    ///Non option type arguments.
-
-    ///Gives back a reference to a vector consisting of the program arguments
+    ///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; }
@@ -299 +298 @@
     
     ///This is the type of the return value of ArgParser::operator[]().
-    ///It automatically converts to int, double, bool or std::string if
-    ///the type of the option matches, otherwise it throws an exception.
-    ///(i.e. it performs runtime type checking).
+    ///It automatically converts to \c int, \c double, \c bool or
+    ///\c std::string if the type of the option matches, otherwise it
+    ///throws an exception (i.e. it performs runtime type checking).
     class RefType 
     {
@@ -356 +355 @@
     ///Give back the value of an option
     
-    ///Give back the value of an option
+    ///Give back the value of an option.
     ///\sa RefType
     RefType operator[](const std::string &n)