Changeset 4482 in orxonox.OLD

Timestamp:

Jun 2, 2005, 5:16:08 AM (19 years ago)

Author:

bensch

Message:

orxonox/trunk: lib/util: doxy-tags

Location:

orxonox/trunk/src/lib/util

Files:

• ini_parser.h (modified) (3 diffs)
• substring.h (modified) (2 diffs)

orxonox/trunk/src/lib/util/ini_parser.h

@@ -13 +13 @@
 #include <stdlib.h>
 
-#define PARSELINELENGHT 512
+#define PARSELINELENGHT     512       //!< how many chars to read at once
 
 //! ini-file parser
@@ -20 +20 @@
 */
 class IniParser {
- private:
-        FILE* stream;
-        bool bInSection;
-        char internbuf[PARSELINELENGHT];
-        
  public:
   IniParser (const char* filename);
@@ -33 +28 @@
   int getSection( char* section);
   int nextVar( char* name, char* value);
+
+ private:
+  FILE*         stream;                       //!< A FileStream to be loaded
+  bool          bInSection;                   //!< if the requested parameter is in the section.
+  char          internbuf[PARSELINELENGHT];   //!< a buffer
+        
+
 };
 

orxonox/trunk/src/lib/util/substring.h

@@ -7 +7 @@
 #define _SUBSTRING_H
 
+//! A class that can load one string and split it in multipe ones
 class SubString
 {
  public:
-        
-  SubString( const char* string);
+  SubString(const char* string);
   ~SubString();
                 
@@ -18 +18 @@
                 
  private:
-  char** strings;
-  int n;
+  char**     strings;         //!< strings produced from a single string splitted in multiple strings
+  int        n;               //!< how many splitted parts
 };