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

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/overlays/hud

Files:

• HUDBar.cc (modified) (2 diffs)
• HUDBar.h (modified) (2 diffs)
• HUDHealthBar.h (modified) (1 diff)
• HUDNavigation.cc (modified) (1 diff)
• HUDNavigation.h (modified) (1 diff)
• HUDRadar.cc (modified) (1 diff)
• HUDRadar.h (modified) (1 diff)

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