Changeset 10930 for code/branches/hoverHS15/src/modules/hover/HoverWall.cc

Timestamp:

Dec 7, 2015, 2:32:47 PM (9 years ago)

Author:

meierman

Message:

Finished with comments

File:

• code/branches/hoverHS15/src/modules/hover/HoverWall.cc (modified) (4 diffs)

code/branches/hoverHS15/src/modules/hover/HoverWall.cc

@@ -21 +21 @@
  *
  *   Author:
- *      Fabien Vultier
+ *      Manuel Meier
  *   Co-authors:
  *      ...
@@ -29 +29 @@
 /**
     @file HoverWall.cc
-    @brief All platforms in this minigame inherit from this class. The basic functions of a platform (interact with figure) is implemented here. Special functions are implemented in the specialized classes.
+    @brief Represents one Wall piece in the Hover Game
 */
 
@@ -54 +54 @@
     }
 
+
+    /**
+    @brief
+        Constructor of a HoverWall
+    @param x
+        x-Coordinate of the Square that the Wall is attached to, 0-9, Origin is Bottom left
+    @param y
+        y-Coordinate of the Square that the Wall is attached to, 0-9, Origin is Bottom left
+    @param orientation
+            Wall on the right side (1) or on top (2) of this square, 0-1        
+    */
     HoverWall::HoverWall(Context* context, int x, int y, int orientation) : StaticEntity(context)
     {
@@ -101 +112 @@
     }
 
-    //xml port for loading height and width of the platform
+    //xml port for loading height and width of the platform, unused
     void HoverWall::XMLPort(Element& xmlelement, XMLPort::Mode mode)
     {
         SUPER(HoverWall, XMLPort, xmlelement, mode);
-
-       // XMLPortParam(HoverWall, "height", setHeight, getHeight, xmlelement, mode);
-        //XMLPortParam(HoverWall, "width", setWidth, getWidth, xmlelement, mode);
     }