Changeset 204:77d56a21c3ab in lemon-1.2 for lemon/arg_parser.h

Timestamp:

07/12/08 10:21:44 (16 years ago)

Author:

Peter Kovacs <kpeter@…>

Branch:

default

Phase:

public

Message:

Doc improvements related to ArgParser?

File:

• lemon/arg_parser.h (modified) (14 diffs)

lemon/arg_parser.h

@@ -119 +119 @@
   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.
@@ -136 +142 @@
     ///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.
@@ -146 +153 @@
     ///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.
@@ -157 +165 @@
     ///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.
@@ -165 +174 @@
                       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.
@@ -173 +192 @@
     ///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.
@@ -183 +203 @@
     ///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.
@@ -193 +214 @@
     ///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.
@@ -204 +226 @@
     ///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.
@@ -219 +242 @@
     ///@{
 
-    ///Boundle some options into a group
+    ///Bundle some options into a group
 
     /// You can group some option by calling this function repeatedly for each
@@ -231 +254 @@
 
     ///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);
   
@@ -248 +271 @@
     
     ///@}
-
-    ///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);
@@ -287 +293 @@
     }
     
+    ///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) 
@@ -361 +370 @@
       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