lemon-1.2: comparison lemon/arg

equal deleted inserted replaced

-:dfe22f56f005
+:110b85270adf
 		    const std::string &help,
 		    void (*func)(void *),void *data);
 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.
 ///\param obl Indicate if the option is mandatory.
 ArgParser &intOption(const std::string &name,
 		    const std::string &help,
 		    int value=0, bool obl=false);
 ///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.
 ///\param obl Indicate if the option is mandatory.
 ArgParser &doubleOption(const std::string &name,
 		      const std::string &help,
 		      double value=0, bool obl=false);
 ///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.
 ///\param obl Indicate if the option is mandatory.
 ///\note A mandatory bool obtion is of very little use.
 		      const std::string &help,
 		      bool value=false, bool obl=false);
 ///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.
 ///\param obl Indicate if the option is mandatory.
 ArgParser &stringOption(const std::string &name,
 		      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.
 ///@{
 ///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.
 ///\retval ref The value of the argument will be written to this variable.
 ArgParser &refOption(const std::string &name,
 		    const std::string &help,
 		    int &ref, bool obl=false);
 ///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.
 ///\retval ref The value of the argument will be written to this variable.
 ArgParser &refOption(const std::string &name,
 		      const std::string &help,
 		      double &ref, bool obl=false);
 ///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.
 ///\retval ref The value of the argument will be written to this variable.
 ///\note A mandatory bool obtion is of very little use.
 		      const std::string &help,
 		      bool &ref, bool obl=false);
 ///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.
 ///\retval ref The value of the argument will be written to this variable.
 ArgParser &refOption(const std::string &name,
 ///\name Option Groups and Synonyms
 ///
 ///@{
-///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.
 ///\param group The group name.
 ///\param opt The option name.
 			   const std::string &opt);
 ///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
 ///Using this function, at least one of the members of \c group
 ///option \c opt.
 ArgParser &synonym(const std::string &syn,
 			   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);
 void showHelp(Opts::iterator i);
 void showHelp(std::vector<OtherArg>::iterator i);
 ArgParser &run()
 {
 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)
 {
 Opts::iterator i = _opts.find(op);
 return i!=_opts.end()?i->second.set:false;
 ///\sa RefType
 RefType operator[](const std::string &n)
 {
 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_ARG_PARSER
-#endif // LEMON_MAIN_PARAMS

changeset 204	77d56a21c3ab
parent 108	889d0c289d19
child 209	765619b7cbb2