Changeset 7297 for code/branches/doc/src/libraries/util/SubString.h

Timestamp:

Aug 31, 2010, 8:37:29 PM (14 years ago)

Author:

landauf

Message:

fixed lots of Doxygen warnings

Note: Doxygen prints a warning if only a part of the parameters of a function are documented.

Added documentation for missing parameters (as good as I could), removed documentation of obsolete parameters and fixed names of renamed parameters.
Some parameters are tagged with "FIXME", please replace this with an appropriate documentation if you know what it does.

File:

• code/branches/doc/src/libraries/util/SubString.h (modified) (2 diffs)

code/branches/doc/src/libraries/util/SubString.h

@@ -115 +115 @@
         unsigned int split(const std::string& string,
                            const std::string& delimiters, const std::string& delimiterNeighbours = "", bool emptyEntries = false,
-                           char escapeChar ='\\', bool removeExcapeChar = true, char safemode_char = '"', bool removeSafemodeChar = true,
+                           char escapeChar ='\\', bool removeEscapeChar = true, char safemode_char = '"', bool removeSafemodeChar = true,
                            char openparenthesis_char = '{', char closeparenthesis_char = '}',  bool removeParenthesisChars = true, char comment_char = '\0');
         std::string join(const std::string& delimiter = " ") const;
@@ -152 +152 @@
                                           bool emptyEntries = false,
                                           char escape_char = '\\',
-                                          bool removeExcapeChar = true,
+                                          bool removeEscapeChar = true,
                                           char safemode_char = '"',
                                           bool removeSafemodeChar = true,