Changeset 7291 for code/branches/doc/src/libraries/core

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/core/XMLPort.h (modified) (2 diffs)

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