Changeset 7297 for code/branches/doc/src/orxonox/overlays/OverlayGroup.cc

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.

File:

• code/branches/doc/src/orxonox/overlays/OverlayGroup.cc (modified) (4 diffs)

code/branches/doc/src/orxonox/overlays/OverlayGroup.cc

@@ -71 +71 @@
         BaseObject::XMLPort()
     */
-    void OverlayGroup::XMLPort(Element& xmlElement, XMLPort::Mode mode)
-    {
-        SUPER(OverlayGroup, XMLPort, xmlElement, mode);
-
-        XMLPortParam(OverlayGroup, "scale",  setScale,  getScale,  xmlElement, mode);
-        XMLPortParam(OverlayGroup, "scroll", setScroll, getScroll, xmlElement, mode);
+    void OverlayGroup::XMLPort(Element& xmlelement, XMLPort::Mode mode)
+    {
+        SUPER(OverlayGroup, XMLPort, xmlelement, mode);
+
+        XMLPortParam(OverlayGroup, "scale",  setScale,  getScale,  xmlelement, mode);
+        XMLPortParam(OverlayGroup, "scroll", setScroll, getScroll, xmlelement, mode);
         // loads all the child elements
-        XMLPortObject(OverlayGroup, OrxonoxOverlay, "", addElement, getElement, xmlElement, mode);
+        XMLPortObject(OverlayGroup, OrxonoxOverlay, "", addElement, getElement, xmlelement, mode);
     }
 
@@ -114 +114 @@
     @brief
         Removes an element from the map.
-    @param name
-        The name of the element that is removed.
+    @param element
+        A pointer to the element that is removed.
     @return
         Returns true if there was such an element to remove, false if not.
@@ -181 +181 @@
         The name of the group defined BaseObject::setName() (usually done with the "name"
         attribute in the xml file).
+    @param scale
+        The scaling factor
     */
     /*static*/ void OverlayGroup::scaleGroup(const std::string& name, float scale)
@@ -197 +199 @@
         The name of the group defined BaseObject::setName() (usually done with the "name"
         attribute in the xml file).
+    @param scroll
+        The relative translation of the overlay group
     */
     /*static*/ void OverlayGroup::scrollGroup(const std::string& name, const Vector2& scroll)