Changeset 7297 for code/branches/doc/src/libraries/util/Exception.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/Exception.h (modified) (1 diff)

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

@@ -60 +60 @@
         @param description
             Exception description as string. This message is supposed to help developers!
+        @param lineNumber
+            The number of the code-line in which the exception occurred
+        @param filename
+            The file in which the exception occurred
+        @param functionName
+            The function in which the exception occurred
         */
         Exception(const std::string& description, unsigned int lineNumber,