Changeset 9881 in orxonox.OLD for trunk/src/lib/parser/ini_parser/ini_parser.h

Timestamp:

Oct 10, 2006, 4:23:28 PM (18 years ago)

Author:

bensch

Message:

many doxygen tags

File:

• trunk/src/lib/parser/ini_parser/ini_parser.h (modified) (11 diffs)

trunk/src/lib/parser/ini_parser/ini_parser.h

@@ -8 +8 @@
 #ifndef _INI_PARSER_H
 #define _INI_PARSER_H
-
-#define PARSELINELENGHT     512       //!< how many chars to read at once
 
 #include <string>
@@ -22 +20 @@
 public:
   ////////////////////////////////////
-  /// A Node for a Ini-Node. The base of all INI-elements.
+  /// A class for a Ini-Node. The base of all INI-elements.
   class Node
   {
   public:
     Node(const std::string& name, const std::string& comment = "");
+    //! Simple destructor
     virtual ~Node() {};
+    /** @returns the name of the Node */
     const std::string& name() const  { return _name; };
+    /** @returns the Comment of the Node */
     const std::string& comment() const  { return _comment; };
+    /** @param name the name to set for this node */
     void setName(const std::string& name) { this->_name = name; };
+    /** @param comment the Comment to set for this node */
     void setComment(const std::string& comment) { this->_comment = comment; };
 
+    /** @param name the name to compare against this nodes name @returns true on match */
     bool operator==(const std::string& name) const { return _name == name; };
-    bool operator==(const Node& node) const { return this->_name == node._name; };
-
+
+    /** @brief displays some debug information about the node */
     virtual void debug() const = 0;
 
@@ -48 +52 @@
   public:
     Entry(const std::string& name, const std::string& value = "", const std::string& comment = "");
+    /** @returns the Value of the Entry */
     const std::string& value() const { return _value; };
+    /** @param value sets the value of the Entry */
     void setValue (const std::string& value) { _value = value; };
 
@@ -54 +60 @@
 
   public:
-    typedef std::list<Entry>                    list;
-    typedef list::iterator                      iterator;
-    typedef list::const_iterator                const_iterator;
-
-  private:
-    std::string         _value;    //!< value of a given Entry
+    typedef std::list<Entry>       list;           //!< A Type definition for lists of Entries.
+    typedef list::iterator         iterator;       //!< A Type definition for iterators of Entries.
+    typedef list::const_iterator   const_iterator; //!< A Type definition for constant iterators of Entries.
+
+  private:
+    std::string                    _value;         //!< value of a given Entry
   };
 
@@ -75 +81 @@
     const std::string& getEntryComment(const std::string& entryName) const;
 
+    /** @returns the List of Entries */
     const Entry::list& entries() const { return _entries; }
     Entry* getEntry(const std::string& entryName);
 
     Entry::const_iterator getEntryIt(const std::string& entryName) const;
+    /** @returns an Iterator pointing to the beginning of the entries. */
     Entry::iterator begin() { return _entries.begin(); };
+    /** @returns a constant Iterator pointing to the beginning of the entries */
     Entry::const_iterator begin() const { return _entries.begin(); };
+    /** @returns an Iterator pointing to the end of the entries */
     Entry::iterator end() { return _entries.end(); };
+    /** @returns a constant Iterator pointing to the end of the entries */
     Entry::const_iterator end() const { return _entries.end(); };
 
@@ -89 +100 @@
 
   public:
-    typedef std::list<Section>                  list;
-    typedef list::iterator                      iterator;
-    typedef list::const_iterator                const_iterator;
-
-  private:
-    Entry::list     _entries;  //!< a list of entries for this section
+    typedef std::list<Section>      list;            //!< A Type definition for lists of Sections
+    typedef list::iterator          iterator;        //!< A Type definition for iterators of Sectionlists.
+    typedef list::const_iterator    const_iterator;  //!< A Type definition for constant iterators of Sectionlists.
+
+  private:
+    Entry::list                     _entries;        //!< a list of entries for this section
   };
 
@@ -107 +118 @@
     bool setSectionComment(const std::string& sectionName, const std::string& comment);
 
+    /** @returns list of all sections */
     const Section::list& sections() const { return _sections; }
     Section* getSection(const std::string& sectionName);
 
     Section::const_iterator getSectionIt(const std::string& sectionName) const;
+    /** @returns an Iterator poining to the beginning of the Sections List */
     Section::iterator begin() { return _sections.begin(); };
+    /** @returns a constant Iterator poining to the beginning of the Sections List */
     Section::const_iterator begin() const { return _sections.begin(); };
+    /** @returns an Iterator poining to the end of the Sections List */
     Section::iterator end() { return _sections.end(); };
+    /** @returns a constant Iterator poining to the end of the Sections List */
     Section::const_iterator end() const { return _sections.end(); };
 
@@ -128 +144 @@
 
   private:
-    Section::list            _sections;        //!< a list of all stored Sections of the Parser.
+    Section::list       _sections;        //!< a list of all stored Sections of the Parser.
   };
 
@@ -142 +158 @@
   /// Read and Write the File
   bool readFile(const std::string& fileName, bool keepSettings = false);
-  bool writeFile(const std::string& fileName) const;
+  bool writeFile(const std::string& fileName = "") const;
 
   void setFileComment(const std::string& fileComment);
+  /** @returns comments for the File. */
   const std::string& getFileComment() const { return this->_document.comment(); };
 
@@ -150 +167 @@
   Section& addSection(const std::string& sectionName);
   // iterate through sections with these Functions
+  //! see Section::getSection()
   Section* getSection(const std::string& sectionName) { return this->_document.getSection(sectionName); };
   Section::const_iterator getSectionIt(const std::string& sectionName) const;
 
+  //! see Section::begin()
   Section::iterator begin() { return this->_document.begin(); };
+  //! see Section::begin()
   Section::const_iterator begin() const { return this->_document.begin(); };
+    //! see Section::end()
   Section::iterator end() { return this->_document.end(); };
+    //! see Section::end()
   Section::const_iterator end() const { return this->_document.end(); };
 
@@ -175 +197 @@
   void setNodeComment(Node* node, std::list<std::string>* comments);
 private:
-  std::string                      _fileName;
-  Document                         _document;
+  std::string                      _fileName;        //!< The name of the File that is parsed here.
+  Document                         _document;        //!< The Document inside of the file.
 
   static const std::string         _emptyString;     //!< Just an Empty String that will be returned if nothing else is found.