Changeset 90:2981a73d49a3 in lemon-main

Timestamp:

03/17/08 13:44:13 (17 years ago)

Author:

Alpar Juttner <alpar@…>

Branch:

default

Phase:

public

Message:

Doc improvement in ArgParser?

File:

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

lemon/arg_parser.h

@@ -128 +128 @@
     ///\param name The name of the option. The leading '-' must be omitted.
     ///\param help A help string.
-    ///\retval value The value of the argument will be written to this variable.
+    ///\param value A default value for the option
     ///\param obl Indicate if the option is mandatory.
     ArgParser &intOption(const std::string &name,
@@ -138 +138 @@
     ///\param name The name of the option. The leading '-' must be omitted.
     ///\param help A help string.
-    ///\retval value The value of the argument will be written to this variable.
+    ///\param value A default value for the option
     ///\param obl Indicate if the option is mandatory.
     ArgParser &doubleOption(const std::string &name,
@@ -148 +148 @@
     ///\param name The name of the option. The leading '-' must be omitted.
     ///\param help A help string.
-    ///\retval value The value of the argument will be written to this variable.
+    ///\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.)
@@ -159 +159 @@
     ///\param name The name of the option. The leading '-' must be omitted.
     ///\param help A help string.
-    ///\retval value The value of the argument will be written to this variable.
+    ///\param value A default value for the option
     ///\param obl Indicate if the option is mandatory.
     ArgParser &stringOption(const std::string &name,
@@ -175 +175 @@
     ///\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.
-    ///\param obl Indicate if the option is mandatory.
     ArgParser &refOption(const std::string &name,
                     const std::string &help,
@@ -185 +185 @@
     ///\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.
-    ///\param obl Indicate if the option is mandatory.
     ArgParser &refOption(const std::string &name,
                       const std::string &help,
@@ -195 +195 @@
     ///\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.
-    ///\param obl Indicate if the option is mandatory.
     ////\note A mandatory bool obtion is of very little use.)
     ArgParser &refOption(const std::string &name,