Changeset 9756 in orxonox.OLD for branches/new_class_id/src/lib/util/substring.h

Timestamp:

Sep 18, 2006, 9:37:01 PM (18 years ago)

Author:

bensch

Message:

doxygened SubString and MultiType

File:

• branches/new_class_id/src/lib/util/substring.h (modified) (2 diffs)

branches/new_class_id/src/lib/util/substring.h

@@ -33 +33 @@
 {
 public:
+  //! An enumerator for the State the Parser is in
   typedef enum {
-    SL_NORMAL,
-    SL_ESCAPE,
-    SL_SAFEMODE,
-    SL_SAFEESCAPE,
-    SL_COMMENT,
+    SL_NORMAL,            //!< Normal state
+    SL_ESCAPE,            //!< After an escape character
+    SL_SAFEMODE,          //!< In safe mode (between "" mostly).
+    SL_SAFEESCAPE,        //!< In safe mode with the internal escape character, that escapes even the savemode character.
+    SL_COMMENT,           //!< In Comment mode.
   } SPLIT_LINE_STATE;
 
@@ -48 +49 @@
             const std::string& delimiters, const std::string& delimiterNeighbours = "", bool emptyEntries=false,
             char escapeChar ='\\', char safemode_char = '"', char comment_char = '\0');
+  SubString(unsigned int argc, const char** argv);
   /** @brief create a Substring as a copy of another one. @param subString the SubString to copy. */
-  SubString(unsigned int argc, const char** argv);
   SubString(const SubString& subString) { *this = subString; };
   SubString(const SubString& subString, unsigned int subSetBegin);