Changeset 5017 in orxonox.OLD

Timestamp:

Aug 14, 2005, 5:43:02 PM (19 years ago)

Author:

bensch

Message:

orxonox/trunk: doxygen tags

Location:

orxonox/trunk/src/lib/util

Files:

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

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

@@ -29 +29 @@
 /**
  *  constructs an IniParser using a file
- * @param filename: the path and name of the file to parse
+ * @param fileName: the path and name of the file to parse
 */
 IniParser::IniParser (const char* fileName)
@@ -88 +88 @@
 /**
  * opens another file to parse
- * @param filename: path and name of the new file to parse
+ * @param fileName: path and name of the new file to parse
  * @return true on success false otherwise;
 */
@@ -317 +317 @@
 }
 
+/**
+ * output the whole tree in a nice and easy way.
+ */
 void IniParser::debug() const
 {

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

@@ -24 +24 @@
   private:
     ////////////////////////////////////
+    //! a struct for Entries in the Parser's File's Sections
     struct IniEntry
     {
-      char*              name;
-      char*              value;
+      char*              name;     //!< name of a given Entry
+      char*              value;    //!< value of a given Entry
     };
-
+    //! a struct for Sections in the Parser's file
     struct IniSection
     {
-      char*               name;
-      tList<IniEntry>*    entries;
+      char*               name;    //!< name of a given section
+      tList<IniEntry>*    entries; //!< a list of entries for this section
     };
     ////////////////////////////////////
@@ -69 +70 @@
 
   private:
-    tList<IniSection>*    sections;
-    IniSection*           currentSection;
-    IniEntry*             currentEntry;
+    tList<IniSection>*    sections;        //!< a list of all stored Sections of the Parser
+    IniSection*           currentSection;  //!< the current selected Section
+    IniEntry*             currentEntry;    //!< the current selected entry (in currentSection)
 };