nojhan/eodev
Archived
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

fix most of the doxygen warnings

Browse source
This commit is contained in:
Johann Dreo 2010-11-09 11:44:28 +01:00
commit faaf13194f
42 changed files with 84 additions and 52 deletions
Download patch file Download diff file Expand all files Collapse all files

10
eo/src/utils/eoParser.h
View file

@ -64,7 +64,7 @@ public :
* @param _defaultValue The default value
* @param _longName Long name of the argument
* @param _description Description of the parameter. What is useful for.
* @param _shortName Short name of the argument (Optional)
* @param _shortHand Short name of the argument (Optional)
* @param _section Name of the section where the parameter belongs
* @param _required If it is a necessary parameter or not
*/
@ -128,8 +128,14 @@ public:
*/
void processParam(eoParam& param, std::string section = "");
/** Read from a stream
* @param is the input stream
*/
void readFrom(std::istream& is);
/** Pint on a stream
* @param os the output stream
*/
void printOn(std::ostream& os) const;
/// className for readibility
@ -207,7 +213,7 @@ public:
@param _defaultValue Default value.
@param _longName Long name of the argument.
@param _description Description of the parameter.
@param _shortName Short name of the argument (Optional)
@param _shortHand Short name of the argument (Optional)
@param _section Name of the section where the parameter belongs.
@param _required Is the parameter mandatory?
@return Corresponding parameter.