Changeset - r90:2981a73d49a3
« 89:e6452a
91:e28fc7 »
gravatar
alpar (Alpar Juttner)
alpar@cs.elte.hu
Doc improvement in ArgParser
0 1 0
default
1 file changed with 7 insertions and 7 deletions:
lemon/arg_parser.h
7
7
↑ Collapse diff ↑
lemon/arg_parser.h
Show white space 12 line context
... ... 
@@ -124,44 +124,44 @@
124 124 
    ~ArgParser();
125 125 

			




	126
	126
	
		
    ///Add a new integer type option


			




	127
	127
	
		

			




	128
	128
	
		
    ///\param name The name of the option. The leading '-' must be omitted.


			




	129
	129
	
		
    ///\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


			




	131
	131
	
		
    ///\param obl Indicate if the option is mandatory.


			




	132
	132
	
		
    ArgParser &intOption(const std::string &name,


			




	133
	133
	
		
		    const std::string &help,


			




	134
	134
	
		
		    int value=0, bool obl=false);


			




	135
	135
	
		

			




	136
	136
	
		
    ///Add a new floating point type option


			




	137
	137
	
		

			




	138
	138
	
		
    ///\param name The name of the option. The leading '-' must be omitted.


			




	139
	139
	
		
    ///\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


			




	141
	141
	
		
    ///\param obl Indicate if the option is mandatory.


			




	142
	142
	
		
    ArgParser &doubleOption(const std::string &name,


			




	143
	143
	
		
		      const std::string &help,


			




	144
	144
	
		
		      double value=0, bool obl=false);


			




	145
	145
	
		

			




	146
	146
	
		
    ///Add a new bool type option


			




	147
	147
	
		

			




	148
	148
	
		
    ///\param name The name of the option. The leading '-' must be omitted.


			




	149
	149
	
		
    ///\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


			




	151
	151
	
		
    ///\param obl Indicate if the option is mandatory.


			




	152
	152
	
		
    ////\note A mandatory bool obtion is of very little use.)


			




	153
	153
	
		
    ArgParser &boolOption(const std::string &name,


			




	154
	154
	
		
		      const std::string &help,


			




	155
	155
	
		
		      bool value=false, bool obl=false);


			




	156
	156
	
		

			




	157
	157
	
		
    ///Add a new string type option


			




	158
	158
	
		

			




	159
	159
	
		
    ///\param name The name of the option. The leading '-' must be omitted.


			




	160
	160
	
		
    ///\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


			




	162
	162
	
		
    ///\param obl Indicate if the option is mandatory.


			




	163
	163
	
		
    ArgParser &stringOption(const std::string &name,


			




	164
	164
	
		
		      const std::string &help,


			




	165
	165
	
		
		      std::string value="", bool obl=false);


			




	166
	166
	
		

			




	167
	167
	
		
    ///\name Options with external storage


			




	...
	...
	
		
@@ -171,34 +171,34 @@


			




	171
	171
	
		
    ///@{


			




	172
	172
	
		

			




	173
	173
	
		
    ///Add a new integer type option with a storage reference


			




	174
	174
	
		

			




	175
	175
	
		
    ///\param name The name of the option. The leading '-' must be omitted.


			




	176
	176
	
		
    ///\param help A help string.


			




	
	177
	
		
    ///\param obl Indicate if the option is mandatory.


			




	177
	178
	
		
    ///\retval ref The value of the argument will be written to this variable.


			




	178
	
	
		
    ///\param obl Indicate if the option is mandatory.


			




	179
	179
	
		
    ArgParser &refOption(const std::string &name,


			




	180
	180
	
		
		    const std::string &help,


			




	181
	181
	
		
		    int &ref, bool obl=false);


			




	182
	182
	
		

			




	183
	183
	
		
    ///Add a new floating type option with a storage reference


			




	184
	184
	
		

			




	185
	185
	
		
    ///\param name The name of the option. The leading '-' must be omitted.


			




	186
	186
	
		
    ///\param help A help string.


			




	
	187
	
		
    ///\param obl Indicate if the option is mandatory.


			




	187
	188
	
		
    ///\retval ref The value of the argument will be written to this variable.


			




	188
	
	
		
    ///\param obl Indicate if the option is mandatory.


			




	189
	189
	
		
    ArgParser &refOption(const std::string &name,


			




	190
	190
	
		
		      const std::string &help,


			




	191
	191
	
		
		      double &ref, bool obl=false);


			




	192
	192
	
		

			




	193
	193
	
		
    ///Add a new bool type option with a storage reference


			




	194
	194
	
		

			




	195
	195
	
		
    ///\param name The name of the option. The leading '-' must be omitted.


			




	196
	196
	
		
    ///\param help A help string.


			




	
	197
	
		
    ///\param obl Indicate if the option is mandatory.


			




	197
	198
	
		
    ///\retval ref The value of the argument will be written to this variable.


			




	198
	
	
		
    ///\param obl Indicate if the option is mandatory.


			




	199
	199
	
		
    ////\note A mandatory bool obtion is of very little use.)


			




	200
	200
	
		
    ArgParser &refOption(const std::string &name,


			




	201
	201
	
		
		      const std::string &help,


			




	202
	202
	
		
		      bool &ref, bool obl=false);


			




	203
	203
	
		

			




	204
	204
	
		
    ///Add a new string type option with a storage reference


			




        

    






    
    



    


    

     
    
0 comments (0 inline)