Changeset 7401 for code/trunk/src/libraries/core/XMLPort.h

Timestamp:

Sep 11, 2010, 12:34:00 AM (15 years ago)

Author:

landauf

Message:

merged doc branch back to trunk

Location:

code/trunk

Files:

• . (modified) (1 prop)
• src/libraries/core/XMLPort.h (modified) (9 diffs)

code/trunk/src/libraries/core/XMLPort.h

@@ -28 +28 @@
 
 /**
+    @defgroup XMLPort XMLPort
+    @ingroup XML
+*/
+
+/**
     @file
+    @ingroup XML XMLPort
     @brief Declaration of the XMLPort helper classes and macros.
 
@@ -69 +75 @@
 
     In the XML file, a param or attribute will be set like this:
+    @code
     <classname paramname="value" />
+    @endcode
 
     The macro will then call loadfunction(value) to set the given value (or call savefunction() to
@@ -88 +96 @@
 
     In the XML file, a param or attribute will be set like this:
+    @code
     <classname paramname="value" />
+    @endcode
 
     The macro will then store "value" in the variable or read it when saving.
@@ -148 +158 @@
     @param paramname The name of the attribute
     @param loadfunction The function to set the attribute inside of the member object.
-    @param loadfunction The function to get the attribute from the member object
+    @param savefunction The function to get the attribute from the member object
+    @param xmlelement The XML-element that is parsed by this macro
+    @param mode Loading or saving
 
     Sometimes you'll have a member object in your class, which has it's own load- and savefunctions.
     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
@@ -196 +208 @@
     @param sectionname The name of the subsection in the XML file that encloses the sub-objects ("" means no subsection)
     @param loadfunction The function to add a new object to the class
-    @param loadfunction The function to get all added objects from the class
+    @param savefunction The function to get all added objects from the class
     @param xmlelement The XMLElement (received through the XMLPort function)
     @param mode The mode (load/save) (received through the XMLPort function)
@@ -210 +222 @@
     likely the best option, so this is usually true.
 
-    @note
+    @details
     The load- and savefunctions have to follow an exactly defined protocol.
     Loadfunction:
       The loadfunction gets a pointer to the object.
-      > void loadfunction(objectclass* pointer);
+      @code
+      void loadfunction(objectclass* pointer);
+      @endcode
 
     Savefunction:
@@ -220 +234 @@
       gets called again, but with index + 1. It's the functions responsibility to do something smart
       with the index and to return 0 if all objects were returned.
-      > objectclass* savefunction(unsigned int index) const;
+      @code
+      objectclass* savefunction(unsigned int index) const;
+      @endcode
 
       Possible implementation:
+      @code
         objectclass* savefunction(unsigned int index) const
         {
@@ -230 +247 @@
             return 0;
         }
-
-    @example
+      @endcode
+
+    Example:
     Possible usage of the macro:
-    > XMLPortObject(SpaceShip, Weapon, "weapons", addWeapon, getWeapon, xmlelement, mode, false, true);
+    @code
+    XMLPortObject(SpaceShip, Weapon, "weapons", addWeapon, getWeapon, xmlelement, mode, false, true);
+    @endcode
 
     Now you can add weapons through the XML file:
+    @code
     <SpaceShip someattribute="..." ...>
       <weapons>
@@ -243 +264 @@
       </weapons>
     </SpaceShip>
+    @endcode
 
     Note that "weapons" is the subsection. This allows you to add more types of sub-objects. In our example,