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

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

Files:

• notifications/Notification.cc (modified) (1 diff)
• notifications/NotificationQueue.cc (modified) (1 diff)
• notifications/NotificationQueue.h (modified) (1 diff)
• objects/Planet.cc (modified) (1 diff)
• objects/triggers/DistanceMultiTrigger.h (modified) (1 diff)
• objects/triggers/MultiTrigger.cc (modified) (1 diff)
• overlays/FadeoutText.h (modified) (1 diff)
• overlays/GUIOverlay.cc (modified) (1 diff)
• overlays/GUIOverlay.h (modified) (1 diff)
• overlays/OverlayText.cc (modified) (1 diff)
• overlays/OverlayText.h (modified) (1 diff)
• overlays/hud/HUDBar.cc (modified) (2 diffs)
• overlays/hud/HUDBar.h (modified) (2 diffs)
• overlays/hud/HUDHealthBar.h (modified) (1 diff)
• overlays/hud/HUDNavigation.cc (modified) (1 diff)
• overlays/hud/HUDNavigation.h (modified) (1 diff)
• overlays/hud/HUDRadar.cc (modified) (1 diff)
• overlays/hud/HUDRadar.h (modified) (1 diff)
• overlays/stats/Scoreboard.cc (modified) (1 diff)
• overlays/stats/Scoreboard.h (modified) (1 diff)
• overlays/stats/Stats.cc (modified) (1 diff)
• overlays/stats/Stats.h (modified) (1 diff)
• pickup/DroppedPickup.cc (modified) (1 diff)
• pickup/Pickup.cc (modified) (1 diff)
• pickup/PickupCollection.cc (modified) (2 diffs)
• pickup/PickupCollectionIdentifier.cc (modified) (1 diff)
• pickup/PickupSpawner.cc (modified) (1 diff)
• pickup/items/SpeedPickup.cc (modified) (1 diff)
• questsystem/AddQuestHint.cc (modified) (1 diff)
• questsystem/Quest.cc (modified) (4 diffs)
• questsystem/QuestEffectBeacon.cc (modified) (1 diff)
• questsystem/QuestNotification.cc (modified) (1 diff)

code/branches/doc/src/modules/notifications/Notification.cc

@@ -55 +55 @@
     @brief
         Constructor. Creates a Notification with the input message.
+    @param creator
+        The object that created this Notification
     @param message
         The message of the Notification.

code/branches/doc/src/modules/notifications/NotificationQueue.cc

@@ -109 +109 @@
         Method for creating a NotificationQueue object through XML.
     */
-    void NotificationQueue::XMLPort(Element& xmlElement, XMLPort::Mode mode)
-    {
-        SUPER(NotificationQueue, XMLPort, xmlElement, mode);
+    void NotificationQueue::XMLPort(Element& xmlelement, XMLPort::Mode mode)
+    {
+        SUPER(NotificationQueue, XMLPort, xmlelement, mode);
 
         this->setDefaults();
 
-        XMLPortParam(NotificationQueue, "maxSize", setMaxSize, getMaxSize, xmlElement, mode);
-        XMLPortParam(NotificationQueue, "notificationLength", setNotificationLength, getNotificationLength, xmlElement, mode);
-        XMLPortParam(NotificationQueue, "displayTime", setDisplayTime, getDisplayTime, xmlElement, mode);
-        XMLPortParam(NotificationQueue, "targets", setTargets, getTargets, xmlElement, mode);
-        XMLPortParam(NotificationQueue, "font", setFont, getFont, xmlElement, mode);
-        XMLPortParam(NotificationQueue, "fontSize", setFontSize, getFontSize, xmlElement, mode);
-        XMLPortParam(NotificationQueue, "position", setPosition, getPosition, xmlElement, mode);
+        XMLPortParam(NotificationQueue, "maxSize", setMaxSize, getMaxSize, xmlelement, mode);
+        XMLPortParam(NotificationQueue, "notificationLength", setNotificationLength, getNotificationLength, xmlelement, mode);
+        XMLPortParam(NotificationQueue, "displayTime", setDisplayTime, getDisplayTime, xmlelement, mode);
+        XMLPortParam(NotificationQueue, "targets", setTargets, getTargets, xmlelement, mode);
+        XMLPortParam(NotificationQueue, "font", setFont, getFont, xmlelement, mode);
+        XMLPortParam(NotificationQueue, "fontSize", setFontSize, getFontSize, xmlelement, mode);
+        XMLPortParam(NotificationQueue, "position", setPosition, getPosition, xmlelement, mode);
 
         COUT(3) << "NotificationQueue '" << this->getName() << "' created." << std::endl;

code/branches/doc/src/modules/notifications/NotificationQueue.h

@@ -93 +93 @@
             virtual ~NotificationQueue();
 
-            virtual void XMLPort(Element& xmlElement, XMLPort::Mode mode); //!< Method for creating a NotificationQueue object through XML.
+            virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode); //!< Method for creating a NotificationQueue object through XML.
 
             virtual void tick(float dt); //!< To update from time to time.

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

code/branches/doc/src/modules/overlays/FadeoutText.h

@@ -44 +44 @@
             virtual ~FadeoutText() {}
 
-            virtual void XMLPort(Element& xmlElement, XMLPort::Mode mode);
+            virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode);
             virtual void tick(float dt);
 

code/branches/doc/src/modules/overlays/GUIOverlay.cc

@@ -52 +52 @@
     }
 
-    void GUIOverlay::XMLPort(Element& xmlElement, XMLPort::Mode mode)
+    void GUIOverlay::XMLPort(Element& xmlelement, XMLPort::Mode mode)
     {
-        SUPER(GUIOverlay, XMLPort, xmlElement, mode);
+        SUPER(GUIOverlay, XMLPort, xmlelement, mode);
 
-        XMLPortParam(GUIOverlay, "guiname", setGUIName, getGUIName, xmlElement, mode);
+        XMLPortParam(GUIOverlay, "guiname", setGUIName, getGUIName, xmlelement, mode);
     }
 

code/branches/doc/src/modules/overlays/GUIOverlay.h

@@ -44 +44 @@
             virtual ~GUIOverlay();
 
-            virtual void XMLPort(Element& xmlElement, XMLPort::Mode mode);
+            virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode);
 
             void setGUIName(const std::string& name);

code/branches/doc/src/modules/overlays/OverlayText.cc

@@ -71 +71 @@
     }
 
-    void OverlayText::XMLPort(Element& xmlElement, XMLPort::Mode mode)
+    void OverlayText::XMLPort(Element& xmlelement, XMLPort::Mode mode)
     {
-        SUPER(OverlayText, XMLPort, xmlElement, mode);
+        SUPER(OverlayText, XMLPort, xmlelement, mode);
 
-        XMLPortParam(OverlayText, "font",       setFont,            getFont,            xmlElement, mode);
-        XMLPortParam(OverlayText, "colour",     setColour,          getColour,          xmlElement, mode);
-        XMLPortParam(OverlayText, "caption",    setCaption,         getCaption,         xmlElement, mode);
-        XMLPortParam(OverlayText, "textsize",   setTextSize,        getTextSize,        xmlElement, mode);
-        XMLPortParam(OverlayText, "align",      setAlignmentString, getAlignmentString, xmlElement, mode);
-        XMLPortParam(OverlayText, "spacewidth", setSpaceWidth,      getSpaceWidth,      xmlElement, mode);
+        XMLPortParam(OverlayText, "font",       setFont,            getFont,            xmlelement, mode);
+        XMLPortParam(OverlayText, "colour",     setColour,          getColour,          xmlelement, mode);
+        XMLPortParam(OverlayText, "caption",    setCaption,         getCaption,         xmlelement, mode);
+        XMLPortParam(OverlayText, "textsize",   setTextSize,        getTextSize,        xmlelement, mode);
+        XMLPortParam(OverlayText, "align",      setAlignmentString, getAlignmentString, xmlelement, mode);
+        XMLPortParam(OverlayText, "spacewidth", setSpaceWidth,      getSpaceWidth,      xmlelement, mode);
     }
 

code/branches/doc/src/modules/overlays/OverlayText.h

@@ -52 +52 @@
         virtual ~OverlayText();
 
-        virtual void XMLPort(Element& xmlElement, XMLPort::Mode mode);
+        virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode);
 
         void setCaption(const std::string& caption);

code/branches/doc/src/modules/overlays/hud/HUDBar.cc

@@ -55 +55 @@
     }
 
-    void BarColour::XMLPort(Element& xmlElement, XMLPort::Mode mode)
-    {
-        SUPER(BarColour, XMLPort, xmlElement, mode);
-
-        XMLPortParam(BarColour, "colour", setColour, getColour, xmlElement, mode);
-        XMLPortParam(BarColour, "position", setPosition, getPosition, xmlElement, mode);
+    void BarColour::XMLPort(Element& xmlelement, XMLPort::Mode mode)
+    {
+        SUPER(BarColour, XMLPort, xmlelement, mode);
+
+        XMLPortParam(BarColour, "colour", setColour, getColour, xmlelement, mode);
+        XMLPortParam(BarColour, "position", setPosition, getPosition, xmlelement, mode);
     }
 
@@ -104 +104 @@
     }
 
-    void HUDBar::XMLPort(Element& xmlElement, XMLPort::Mode mode)
-    {
-        SUPER(HUDBar, XMLPort, xmlElement, mode);
-
-        XMLPortParam(HUDBar, "initialvalue", setValue,       getValue,       xmlElement, mode);
-        XMLPortParam(HUDBar, "righttoleft",  setRightToLeft, getRightToLeft, xmlElement, mode);
-        XMLPortParam(HUDBar, "autocolour",   setAutoColour,  getAutoColour,  xmlElement, mode);
-        XMLPortParam(HUDBar, "bartexture",   setBarTexture,  getBarTexture, xmlElement, mode);
-        XMLPortObject(HUDBar, BarColour, "", addColour, getColour, xmlElement, mode);
+    void HUDBar::XMLPort(Element& xmlelement, XMLPort::Mode mode)
+    {
+        SUPER(HUDBar, XMLPort, xmlelement, mode);
+
+        XMLPortParam(HUDBar, "initialvalue", setValue,       getValue,       xmlelement, mode);
+        XMLPortParam(HUDBar, "righttoleft",  setRightToLeft, getRightToLeft, xmlelement, mode);
+        XMLPortParam(HUDBar, "autocolour",   setAutoColour,  getAutoColour,  xmlelement, mode);
+        XMLPortParam(HUDBar, "bartexture",   setBarTexture,  getBarTexture, xmlelement, mode);
+        XMLPortObject(HUDBar, BarColour, "", addColour, getColour, xmlelement, mode);
     }
 

code/branches/doc/src/modules/overlays/hud/HUDBar.h

@@ -50 +50 @@
         virtual ~BarColour() { }
 
-        virtual void XMLPort(Element& xmlElement, XMLPort::Mode mode);
+        virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode);
 
         void setColour(const ColourValue& colour) { this->colour_ = colour; }
@@ -70 +70 @@
         virtual ~HUDBar();
 
-        virtual void XMLPort(Element& xmlElement, XMLPort::Mode mode);
+        virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode);
 
         void clearColours();

code/branches/doc/src/modules/overlays/hud/HUDHealthBar.h

@@ -45 +45 @@
             virtual ~HUDHealthBar();
 
-            virtual void XMLPort(Element& xmlElement, XMLPort::Mode mode);
+            virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode);
             virtual void tick(float dt);
             virtual void changedOwner();

code/branches/doc/src/modules/overlays/hud/HUDNavigation.cc

@@ -90 +90 @@
 }
 
-void HUDNavigation::XMLPort ( Element& xmlElement, XMLPort::Mode mode )
-{
-    SUPER ( HUDNavigation, XMLPort, xmlElement, mode );
-
-    XMLPortParam ( HUDNavigation, "font",          setFont,          getFont,          xmlElement, mode );
-    XMLPortParam ( HUDNavigation, "textSize",      setTextSize,      getTextSize,      xmlElement, mode );
-    XMLPortParam ( HUDNavigation, "navMarkerSize", setNavMarkerSize, getNavMarkerSize, xmlElement, mode );
+void HUDNavigation::XMLPort ( Element& xmlelement, XMLPort::Mode mode )
+{
+    SUPER ( HUDNavigation, XMLPort, xmlelement, mode );
+
+    XMLPortParam ( HUDNavigation, "font",          setFont,          getFont,          xmlelement, mode );
+    XMLPortParam ( HUDNavigation, "textSize",      setTextSize,      getTextSize,      xmlelement, mode );
+    XMLPortParam ( HUDNavigation, "navMarkerSize", setNavMarkerSize, getNavMarkerSize, xmlelement, mode );
 }
 

code/branches/doc/src/modules/overlays/hud/HUDNavigation.h

@@ -51 +51 @@
     void setConfigValues();
 
-    virtual void XMLPort ( Element& xmlElement, XMLPort::Mode mode );
+    virtual void XMLPort ( Element& xmlelement, XMLPort::Mode mode );
     virtual void tick ( float dt );
 

code/branches/doc/src/modules/overlays/hud/HUDRadar.cc

@@ -82 +82 @@
     }
 
-    void HUDRadar::XMLPort(Element& xmlElement, XMLPort::Mode mode)
+    void HUDRadar::XMLPort(Element& xmlelement, XMLPort::Mode mode)
     {
-        SUPER(HUDRadar, XMLPort, xmlElement, mode);
+        SUPER(HUDRadar, XMLPort, xmlelement, mode);
 
-        XMLPortParam(HUDRadar, "sensitivity", setRadarSensitivity, getRadarSensitivity, xmlElement, mode);
-        XMLPortParam(HUDRadar, "halfDotSizeDistance", setHalfDotSizeDistance, getHalfDotSizeDistance, xmlElement, mode);
-        XMLPortParam(HUDRadar, "maximumDotSize", setMaximumDotSize, getMaximumDotSize, xmlElement, mode);
+        XMLPortParam(HUDRadar, "sensitivity", setRadarSensitivity, getRadarSensitivity, xmlelement, mode);
+        XMLPortParam(HUDRadar, "halfDotSizeDistance", setHalfDotSizeDistance, getHalfDotSizeDistance, xmlelement, mode);
+        XMLPortParam(HUDRadar, "maximumDotSize", setMaximumDotSize, getMaximumDotSize, xmlelement, mode);
     }
 

code/branches/doc/src/modules/overlays/hud/HUDRadar.h

@@ -49 +49 @@
         virtual ~HUDRadar();
 
-        virtual void XMLPort(Element& xmlElement, XMLPort::Mode mode);
+        virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode);
         virtual void changedOwner();
 

code/branches/doc/src/modules/overlays/stats/Scoreboard.cc

@@ -54 +54 @@
             this->lines_.pop_back();
         }
-    }
-
-    /**
-        @brief Initializes the lines.
-    */
-    void Scoreboard::XMLPort(Element& xmlElement, XMLPort::Mode mode)
-    {
-        SUPER(Scoreboard, XMLPort, xmlElement, mode);
     }
 

code/branches/doc/src/modules/overlays/stats/Scoreboard.h

@@ -44 +44 @@
         virtual ~Scoreboard();
 
-        virtual void XMLPort(Element& xmlElement, XMLPort::Mode mode);
         virtual void tick(float dt);
 

code/branches/doc/src/modules/overlays/stats/Stats.cc

@@ -98 +98 @@
     }
 
-    /**
-        @brief Initializes the Stats panel.
-    */
-    void Stats::XMLPort(Element& xmlElement, XMLPort::Mode mode)
-    {
-        OrxonoxOverlay::XMLPort(xmlElement, mode);
-    }
-
     void Stats::tick(float dt)
     {

code/branches/doc/src/modules/overlays/stats/Stats.h

@@ -46 +46 @@
         void setConfigValues();
 
-        virtual void XMLPort(Element& xmlElement, XMLPort::Mode mode);
-
         virtual void tick(float dt);
 

code/branches/doc/src/modules/pickup/DroppedPickup.cc

@@ -61 +61 @@
     @param pickup
         The Pickupable that was dropped.
-    @param position
-        The position at which the DroppedPickup should be created.
+    @param carrier
+        FIXME - add doc!
     @param triggerDistance
         The distance at which the PickupSpawner triggers. Default is 10.

code/branches/doc/src/modules/pickup/Pickup.cc

@@ -225 +225 @@
         This method must be implemented by any class directly inheriting from Pickupable. It is most easily done by just creating a new DroppedPickup, e.g.:
         DroppedPickup(BaseObject* creator, Pickupable* pickup, const Vector3& position);
-    @param position
-        The position at which the PickupSpawner should be placed.
     @return
         Returns true if a spawner was created, false if not.

code/branches/doc/src/modules/pickup/PickupCollection.cc

@@ -228 +228 @@
     @brief
         Get whether a given class, represented by the input Identifier, is a target of this PickupCollection.
-    @param identifier
-        A pointer to the PickupIdentifier of the PickupCarrier we want to know of, whether it is a target of this PickupCollection.
+    @param carrier
+        A pointer to the PickupCarrier we want to know of, whether it is a target of this PickupCollection.
     @return
         Returns true if the PickupCarrier identified by the input PickupIdentififer it is a target of this PickupCollection, false if not.
@@ -336 +336 @@
         This method must be implemented by any class directly inheriting from Pickupable. It is most easily done by just creating a new DroppedPickup, e.g.:
         DroppedPickup(BaseObject* creator, Pickupable* pickup, const Vector3& position);
-    @param position
-        The position at which the PickupSpawner should be placed.
     @return
         Returns true if a spawner was created, false if not.

code/branches/doc/src/modules/pickup/PickupCollectionIdentifier.cc

@@ -99 +99 @@
     @brief
         Add a Pickupable to the PickupCollectionIdentifier.
-    @param
+    @param identifier
         A pointer to the PickupIdentifier of the Pickupable to be added.
     */

code/branches/doc/src/modules/pickup/PickupSpawner.cc

@@ -70 +70 @@
     @param respawnTime
         The minimum time between two spawns.
-    @param maySpawnedItems
+    @param maxSpawnedItems
         The maximum number of items spawned by this PickupSpawner.
     */

code/branches/doc/src/modules/pickup/items/SpeedPickup.cc

@@ -252 +252 @@
     @brief
         Sets the SpeedMultiply
-    @param speedAdd
+    @param speedMultiply
         The multiplied Speed
     */

code/branches/doc/src/modules/questsystem/AddQuestHint.cc

@@ -80 +80 @@
     @param id
         The QuestHint id.
-    @param
+    @return
         Returns true if successful.
     */

code/branches/doc/src/modules/questsystem/Quest.cc

@@ -197 +197 @@
     @brief
         Returns the subquest at the given index.
-    @param
+    @param index
         The index.
     @return
@@ -222 +222 @@
     @brief
         Returns the QuestHint at the given index.
-    @param
+    @param index
         The index.
     @return
@@ -246 +246 @@
     @brief
         Returns the fail QuestEffect at the given index.
-    @param
+    @param index
         The index.
     @return
@@ -270 +270 @@
     @brief
         Returns the complete QuestEffect at the given index.
-    @param
+    @param index
         The index.
     @return

code/branches/doc/src/modules/questsystem/QuestEffectBeacon.cc

@@ -92 +92 @@
         Executes the QuestEffectBeacon.
         This means extracting the Pawn from the PlayerTrigger, provided by the Event causing the execution, and the extracting the PlayerInfo from the received Pawn and invoking the QuestEffectbeacon's QuestEffects on the received PlayerInfo.
+    @param b
+        true means the trigger was activated while false means it was deactivated
     @param trigger
         A pointer to the PlayerTrigger that threw the Event.

code/branches/doc/src/modules/questsystem/QuestNotification.cc

@@ -48 +48 @@
     @brief
         Creates a QuestNotification with the input message.
+    @param creator
+        The creator of this object
     @param message
         The message to be sent.