Changeset 7297 for code/branches/doc/src/libraries/util/Convert.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/Convert.h (modified) (2 diffs)

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

@@ -278 +278 @@
         For information about the different conversion methods (user defined too), see the section
         'Actual conversion sequence' in this file above.
+    @param output
+        A pointer to the variable where the converted value will be stored
+    @param input
+        The original value
     */
     template <class FromType, class ToType>
@@ -294 +298 @@
         'Actual conversion sequence' in this file above.
         If the conversion doesn't succeed, 'fallback' is written to '*output'.
+    @param output
+        A pointer to the variable where the converted value will be stored
+    @param input
+        The original value
     @param fallback
         A default value that gets written to '*output' if there is no conversion.