Changeset 2141 in orxonox.OLD for orxonox/branches/chris/src/ini_parser.cc

Timestamp:

Jul 14, 2004, 3:31:42 PM (20 years ago)

Author:

chris

Message:

orxonox/branches/chris: added lots and lots of doxygen tags

File:

• orxonox/branches/chris/src/ini_parser.cc (modified) (6 diffs)

orxonox/branches/chris/src/ini_parser.cc

@@ -19 +19 @@
 using namespace std;
 
+/**
+        \brief constructs an IniParser using a file
+        \param filename: the path and name of the file to parse
+*/
 IniParser::IniParser (char* filename)
 {
@@ -26 +30 @@
 }
 
+/**
+        \brief removes the IniParser from memory
+*/
 IniParser::~IniParser ()
 {
@@ -31 +38 @@
 }
 
+/**
+        \brief opens another file to parse
+        \param filename: path and name of the new file to parse
+        \return zero on success or -1 if an error occured;
+*/
 int IniParser::open_file( char* filename)
 {
@@ -44 +56 @@
 }
 
+/**
+        \brief set the parsing cursor to the specified section
+        \param section: the name of the section to set the cursor to
+        \return zero on success or -1 if the section could not be found
+*/
 int IniParser::get_section( char* section)
 {
@@ -77 +94 @@
 }
 
+/**
+        \brief gets the next VarName=VarValue pair from the parsing stream
+        \param name: a pointer to a buffer to store the name of the entry
+        \param value: a pointer to a buffer to store the value of the entry
+        \return zero if the buffers have been filled with data or -1 if there are no entries left in the current section
+*/
 int IniParser::next_var( char* name, char* value)
 {
@@ -111 +134 @@
 }
 
+/**
+        \brief directly acesses an entry in a section
+        \param name: the name of the entry to find
+        \param section: the section where the entry is to be found
+        \param defvalue: what should be returned in case the entry cannot be found
+        \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
+
+        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
+        lead to unwanted behaviour.
+*/
 char* IniParser::get_var( char* name, char* section, char* defvalue = "")
 {