COIN-OR::LEMON - Graph Library

Changeset 90:2981a73d49a3 in lemon


Ignore:
Timestamp:
03/17/08 13:44:13 (11 years ago)
Author:
Alpar Juttner <alpar@…>
Branch:
default
Phase:
public
Message:

Doc improvement in ArgParser?

File:
1 edited

Legend:

Unmodified
Added
Removed
  • lemon/arg_parser.h

    r88 r90  
    128128    ///\param name The name of the option. The leading '-' must be omitted.
    129129    ///\param help A help string.
    130     ///\retval value The value of the argument will be written to this variable.
     130    ///\param value A default value for the option
    131131    ///\param obl Indicate if the option is mandatory.
    132132    ArgParser &intOption(const std::string &name,
     
    138138    ///\param name The name of the option. The leading '-' must be omitted.
    139139    ///\param help A help string.
    140     ///\retval value The value of the argument will be written to this variable.
     140    ///\param value A default value for the option
    141141    ///\param obl Indicate if the option is mandatory.
    142142    ArgParser &doubleOption(const std::string &name,
     
    148148    ///\param name The name of the option. The leading '-' must be omitted.
    149149    ///\param help A help string.
    150     ///\retval value The value of the argument will be written to this variable.
     150    ///\param value A default value for the option
    151151    ///\param obl Indicate if the option is mandatory.
    152152    ////\note A mandatory bool obtion is of very little use.)
     
    159159    ///\param name The name of the option. The leading '-' must be omitted.
    160160    ///\param help A help string.
    161     ///\retval value The value of the argument will be written to this variable.
     161    ///\param value A default value for the option
    162162    ///\param obl Indicate if the option is mandatory.
    163163    ArgParser &stringOption(const std::string &name,
     
    175175    ///\param name The name of the option. The leading '-' must be omitted.
    176176    ///\param help A help string.
     177    ///\param obl Indicate if the option is mandatory.
    177178    ///\retval ref The value of the argument will be written to this variable.
    178     ///\param obl Indicate if the option is mandatory.
    179179    ArgParser &refOption(const std::string &name,
    180180                    const std::string &help,
     
    185185    ///\param name The name of the option. The leading '-' must be omitted.
    186186    ///\param help A help string.
     187    ///\param obl Indicate if the option is mandatory.
    187188    ///\retval ref The value of the argument will be written to this variable.
    188     ///\param obl Indicate if the option is mandatory.
    189189    ArgParser &refOption(const std::string &name,
    190190                      const std::string &help,
     
    195195    ///\param name The name of the option. The leading '-' must be omitted.
    196196    ///\param help A help string.
     197    ///\param obl Indicate if the option is mandatory.
    197198    ///\retval ref The value of the argument will be written to this variable.
    198     ///\param obl Indicate if the option is mandatory.
    199199    ////\note A mandatory bool obtion is of very little use.)
    200200    ArgParser &refOption(const std::string &name,
Note: See TracChangeset for help on using the changeset viewer.