Changeset 7291 for code/branches/doc/src/libraries/util/Debug.h

Timestamp:

Aug 31, 2010, 5:19:36 PM (15 years ago)

Author:

landauf

Message:

the @example tag shouldn't be used in a documentation unless the whole file is an example implementation

File:

• code/branches/doc/src/libraries/util/Debug.h (modified) (3 diffs)

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

@@ -52 +52 @@
      6: Crazy debug information
 
-@example
+    Example:
+    @code
     COUT(0) << "Very important output" << std::endl;
     COUT(1) << "Error: Something went wrong!" << std::endl;
@@ -58 +59 @@
     COUT(3) << "Info: It's Monday" << std::endl;
     COUT(4) << "Debug: x is 1.23456" << std::endl;
+    @endcode
 */
 
@@ -96 +98 @@
     where (a > b ? 0 : ) stands for COUT(x). This should explain how
     this macro magic can possibly even work ;)
-@example
+
+    Example:
+    @code
     COUT(3) << "Some info" << std::endl;
+    @endcode
 @note
     The ? : operator requires both possible results to have the type of