Changeset 10930 for code/branches/hoverHS15/src/modules/hover/HoverFlag.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/HoverFlag.cc (modified) (6 diffs)

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

@@ -21 +21 @@
  *
  *   Author:
- *      Fabien Vultier
+ *      Manuel Meier
  *   Co-authors:
  *      ...
@@ -29 +29 @@
 /**
     @file HoverFlag.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 The Flags that are being set in the Hover Minigame They support two coordinates from 0-9 each
 */
 
@@ -56 +56 @@
     }
 
+    /**
+    @brief
+        Constructor that expects two coordinate-values in the range 0-9
+    @param xCoordinate
+        X-Coordinate of the flage, 0-9, origin is bottom left
+    @param yCoordinate
+        Y-Coordinate of the flage, 0-9, origin is bottom left
+    */
     HoverFlag::HoverFlag(Context* context, int xCoordinate, int yCoordinate) : StaticEntity(context)
     {
@@ -92 +100 @@
     }
 
-    //xml port for loading height and width of the platform
+    //xml port unused
     void HoverFlag::XMLPort(Element& xmlelement, XMLPort::Mode mode)
     {
@@ -104 +112 @@
     @brief
         Is called every tick.
-        Handles the movement of the ball and its interaction with the boundaries and bats.
     @param dt
         The time since the last tick.
@@ -114 +121 @@
     }
 
+    /**
+    @brief
+        Checks if the Hovership collided with the flag
+    */
     bool HoverFlag::collidesAgainst(WorldEntity* otherObject, const btCollisionShape* ownCollisionShape, btManifoldPoint& contactPoint)
     {