Changeset 7291 for code/branches/doc/src/libraries/util/Math.cc

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

File:

• code/branches/doc/src/libraries/util/Math.cc (modified) (3 diffs)

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).