Changeset 4836 in orxonox.OLD for orxonox/trunk/src/lib/util
- Timestamp:
- Jul 12, 2005, 12:33:16 AM (19 years ago)
-
orxonox/trunk: renamed all the \param → @param and so on in Doxygen tags.
Thanks a lot to the kDevelop team. this took since the last commit
- Location:
- orxonox/trunk/src/lib/util
- Files:
-
- 4 edited
-
ini_parser.cc (modified) (6 diffs)
-
ini_parser.h (modified) (1 diff)
-
list.h (modified) (19 diffs)
-
substring.cc (modified) (3 diffs)
Legend:
- Unmodified
- Added
- Removed
-
orxonox/trunk/src/lib/util/ini_parser.cc
r4767 r4836 23 23 24 24 /** 25 \briefconstructs an IniParser using a file26 \param filename: the path and name of the file to parse25 * constructs an IniParser using a file 26 * @param filename: the path and name of the file to parse 27 27 */ 28 28 IniParser::IniParser (const char* filename) … … 36 36 37 37 /** 38 \briefremoves the IniParser from memory38 * removes the IniParser from memory 39 39 */ 40 40 IniParser::~IniParser () … … 44 44 45 45 /** 46 \briefopens another file to parse47 \param filename: path and name of the new file to parse48 \return zero on success or -1 if an error occured;46 * opens another file to parse 47 * @param filename: path and name of the new file to parse 48 * @return zero on success or -1 if an error occured; 49 49 */ 50 50 int IniParser::openFile(const char* filename) … … 65 65 66 66 /** 67 \briefset the parsing cursor to the specified section68 \param section: the name of the section to set the cursor to69 \return zero on success or -1 if the section could not be found67 * set the parsing cursor to the specified section 68 * @param section: the name of the section to set the cursor to 69 * @return zero on success or -1 if the section could not be found 70 70 */ 71 71 int IniParser::getSection( const char* section) … … 103 103 104 104 /** 105 \briefgets the next VarName=VarValue pair from the parsing stream106 \param name: a pointer to a buffer to store the name of the entry107 \param value: a pointer to a buffer to store the value of the entry108 \return zero if the buffers have been filled with data or -1 if there are no entries left in the current section105 * gets the next VarName=VarValue pair from the parsing stream 106 * @param name: a pointer to a buffer to store the name of the entry 107 * @param value: a pointer to a buffer to store the value of the entry 108 * @return zero if the buffers have been filled with data or -1 if there are no entries left in the current section 109 109 */ 110 110 int IniParser::nextVar( const char* name, const char* value) … … 148 148 149 149 /** 150 \briefdirectly acesses an entry in a section151 \param name: the name of the entry to find152 \param section: the section where the entry is to be found153 \param defvalue: what should be returned in case the entry cannot be found154 \return a pointer to a buffer conatining the value of the specified entry. This buffer will contain the data specified in defvalue in case the entry wasn't found150 * directly acesses an entry in a section 151 * @param name: the name of the entry to find 152 * @param section: the section where the entry is to be found 153 * @param defvalue: what should be returned in case the entry cannot be found 154 * @return a pointer to a buffer conatining the value of the specified entry. This buffer will contain the data specified in defvalue in case the entry wasn't found 155 155 156 156 The returned pointer points to an internal buffer, so do not free it on your own. Do not give a NULL pointer to defvalue, this will certainly -
orxonox/trunk/src/lib/util/ini_parser.h
r4767 r4836 1 1 /*! 2 2 \file ini_parser.h 3 \briefA small ini file parser3 * A small ini file parser 4 4 5 5 Can be used to find a defined [Section] in an ini file and get the VarName=Value entries -
orxonox/trunk/src/lib/util/list.h
r4694 r4836 23 23 24 24 /** 25 \briefan iterator class25 * an iterator class 26 26 27 27 this enables the user to iterate through a list very easely … … 44 44 45 45 /** 46 \briefiterator constructor47 \param startElement: the first list element from the tList46 * iterator constructor 47 * @param startElement: the first list element from the tList 48 48 49 49 normaly you will use it like this: … … 68 68 69 69 /** 70 \briefthe destructor70 * the destructor 71 71 */ 72 72 template<class T> … … 78 78 79 79 /** 80 \briefuse it to iterate through the list81 \returns next list element80 * use it to iterate through the list 81 * @returns next list element 82 82 */ 83 83 template<class T> … … 93 93 94 94 /** 95 \briefgets the element after the selected one, sets the iterator to this point in the list96 \param element the element to seek97 \returns next list element95 * gets the element after the selected one, sets the iterator to this point in the list 96 * @param element the element to seek 97 * @returns next list element 98 98 99 99 Attention: if you seek an element, the iterator pointer will point to the NEXT listelement after the argument! … … 120 120 121 121 /** 122 \briefthe list template class122 * the list template class 123 123 124 124 you will use this as a generic list for all type of objects … … 151 151 152 152 /** 153 \briefthe constructor153 * the constructor 154 154 */ 155 155 template<class T> … … 163 163 164 164 /** 165 \briefthe deconstructor165 * the deconstructor 166 166 167 167 this will delete only the list. ATTENTION: the list is deleted, but the objects in the list will … … 186 186 187 187 /** 188 \briefadd an entity to the list189 \param entity: the entity to add188 * add an entity to the list 189 * @param entity: the entity to add 190 190 */ 191 191 template<class T> … … 207 207 208 208 /** 209 \briefremove an entity from the list210 \param entity: the entity to be removed209 * remove an entity from the list 210 * @param entity: the entity to be removed 211 211 */ 212 212 template<class T> … … 235 235 236 236 /** 237 \briefthis will deletes the objects from the list237 * this will deletes the objects from the list 238 238 */ 239 239 template<class T> … … 255 255 256 256 /** 257 \briefreturns the first element of the list258 \returns first element257 * returns the first element of the list 258 * @returns first element 259 259 */ 260 260 template<class T> … … 266 266 267 267 /** 268 \brieffunction returns the last element of the list269 \returns the last element268 * function returns the last element of the list 269 * @returns the last element 270 270 */ 271 271 template<class T> … … 277 277 278 278 /** 279 \briefreturns true if the list is empty280 \returns true if the list is empty279 * returns true if the list is empty 280 * @returns true if the list is empty 281 281 */ 282 282 template<class T> … … 287 287 288 288 /** 289 \briefchecks if an entity is in the List290 \param entity The entity to check for in the entire List.291 \returns true if it is, false otherwise289 * checks if an entity is in the List 290 * @param entity The entity to check for in the entire List. 291 * @returns true if it is, false otherwise 292 292 */ 293 293 template<class T> … … 311 311 312 312 /** 313 \briefthis returns the number of elements in the list314 \returns number of elements313 * this returns the number of elements in the list 314 * @returns number of elements 315 315 */ 316 316 template<class T> … … 322 322 323 323 /** 324 \briefcreates an itereator object and returns it325 \returns the iterator object to this list324 * creates an itereator object and returns it 325 * @returns the iterator object to this list 326 326 327 327 You will use this, if you want to iterate through the list … … 337 337 338 338 /** 339 \briefthis returns the next element after toEntity or the first if toEntity is last340 \param toEntity: the entity after which is an entity, that has to be returned, sorry, terrible phrase341 \returns the element after toEntity339 * this returns the next element after toEntity or the first if toEntity is last 340 * @param toEntity: the entity after which is an entity, that has to be returned, sorry, terrible phrase 341 * @returns the element after toEntity 342 342 */ 343 343 template<class T> … … 359 359 360 360 /** 361 \briefcreates an array out of the list (ATTENTION: not implemented)362 \returns pointer to the array beginning361 * creates an array out of the list (ATTENTION: not implemented) 362 * @returns pointer to the array beginning 363 363 364 364 ATTENTION: function is not implemented and wont do anything -
orxonox/trunk/src/lib/util/substring.cc
r4833 r4836 18 18 19 19 /** 20 \briefbreaks a string into parts that were initially seperated by comma21 \param string the string to break into substrings20 * breaks a string into parts that were initially seperated by comma 21 * @param string the string to break into substrings 22 22 */ 23 23 … … 68 68 69 69 /** 70 \briefremoves the object from memory70 * removes the object from memory 71 71 */ 72 72 SubString::~SubString() … … 81 81 82 82 /** 83 \briefget a particular substring84 \param i the ID of the substring to return85 \returns the designated substring or NULL if an invalid ID was given83 * get a particular substring 84 * @param i the ID of the substring to return 85 * @returns the designated substring or NULL if an invalid ID was given 86 86 */ 87 87 const char* SubString::getString( int i)
Note: See TracChangeset
for help on using the changeset viewer.
