Changeset 7297 for code/branches/doc/src/libraries/util/StringUtils.cc

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/StringUtils.cc (modified) (3 diffs)

code/branches/doc/src/libraries/util/StringUtils.cc

@@ -142 +142 @@
     /**
         @brief Returns true if the string contains something like '..."between quotes"...'.
-        @param The string
+        @param str The string
         @return True if there is something between quotes
     */
@@ -154 +154 @@
     /**
         @brief If the string contains something like '..."between quotes"...' then 'between quotes' gets returned (without quotes).
-        @param The string
-        @param The string between the quotes
+        @param str The string between the quotes
     */
     std::string getStringBetweenQuotes(const std::string& str)
@@ -169 +168 @@
     /**
         @brief Removes enclosing quotes if available (including whitespaces at the outside of the quotes).
-        @brief str The string to strip
+        @param str The string to strip
         @return The string with removed quotes
     */