Changeset 7291 for code/branches/doc

Timestamp:

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

Author:

landauf

Message:

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

Location:

code/branches/doc/src/libraries

Files:

• core/XMLPort.h (modified) (2 diffs)
• util/Debug.h (modified) (3 diffs)
• util/Math.cc (modified) (3 diffs)
• util/MultiType.h (modified) (2 diffs)
• util/SubString.h (modified) (1 diff)

code/branches/doc/src/libraries/core/XMLPort.h

@@ -153 +153 @@
     With this macro, you can simply use them instead of writing your own functions.
 
-    @example
+    Example:
     Your class is called SpaceShip and this class has an object (myPilot_) of class Pilot. Pilot has a name
     and two functions, setName(name) and getName(). Now you want an attribute "pilotname" in your
@@ -231 +231 @@
         }
 
-    @example
+    Example:
     Possible usage of the macro:
     > XMLPortObject(SpaceShip, Weapon, "weapons", addWeapon, getWeapon, xmlelement, mode, false, true);

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

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

@@ -93 +93 @@
         @return The angle
 
-        @example
+        Examples:
         If the other object is exactly in front of me, the function returns 0.
         If the other object is exactly behind me, the function returns pi.
@@ -116 +116 @@
         @return The viewing direction
 
-        @example
+        Examples:
         If the other object is exactly in front of me, the function returns Vector2(0, 0).
         If the other object is exactly at my left, the function returns Vector2(-1, 0).
@@ -156 +156 @@
         @return The viewing direction
 
-        @example
+        Examples:
         If the other object is exactly in front of me, the function returns Vector2(0, 0).
         If the other object is exactly at my left, the function returns Vector2(-0.5, 0).

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

@@ -52 +52 @@
      - setValue<T>(value) assigns a new value and changes the type to T.
 
-    @example
+    Examples:
+    @code
     MultiType a = 10;;         // a has now the type int and the value 10
     a.setValue("3.14");        // a has still the type int and "3.14" gets converted, therefore the value is now 3
@@ -58 +59 @@
     a.convert<bool>();         // converts 3.14 to bool, which is true
     a = false;                 // assigns false, this is equivalent to a.setValue(false)
+    @endcode
 
     @note

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

@@ -47 +47 @@
  * but also removing leading and trailing spaces around the comma.
  *
- * @example
+ * Example:
  * Split the String std::string st = "1345, The new empire   , is , orxonox"
  * is splitted with:
- * SubString(st, ',', " \n\t")
+ * @code SubString(st, ',', " \n\t") @endcode
  * into
  * "1345", "The new empire", "is", "orxonox"