Changeset 7297 for code/branches/doc/src/modules/objects

Timestamp:

Aug 31, 2010, 8:37:29 PM (14 years ago)

Author:

landauf

Message:

fixed lots of Doxygen warnings

Note: Doxygen prints a warning if only a part of the parameters of a function are documented.

Added documentation for missing parameters (as good as I could), removed documentation of obsolete parameters and fixed names of renamed parameters.
Some parameters are tagged with "FIXME", please replace this with an appropriate documentation if you know what it does.

Location:

code/branches/doc/src/modules/objects

Files:

• Planet.cc (modified) (1 diff)
• triggers/DistanceMultiTrigger.h (modified) (1 diff)
• triggers/MultiTrigger.cc (modified) (1 diff)

code/branches/doc/src/modules/objects/Planet.cc

@@ -144 +144 @@
     }
 
-    /**
-        @brief XML loading and saving.
-        @param xmlelement The XML-element
-        @param loading Loading (true) or saving (false)
-        @return The XML-element
-    */
     void Planet::XMLPort(Element& xmlelement, XMLPort::Mode mode)
     {

code/branches/doc/src/modules/objects/triggers/DistanceMultiTrigger.h

@@ -65 +65 @@
             /**
             @brief Set the target name of DistanceTriggerBeacons that triggers this DistanceMultiTrigger.
-            @param targename The name of the DistanceTriggerBeacon as a string.
+            @param targetname The name of the DistanceTriggerBeacon as a string.
             */
             inline void setTargetName(const std::string& targetname)

code/branches/doc/src/modules/objects/triggers/MultiTrigger.cc

@@ -308 +308 @@
     @brief
         Get whether the MultiTrigger is active for a given object.
-    @param triggerers
+    @param triggerer
         A pointer to the object.
     @return