Changeset 8104 for code/branches/tetris/src/modules/pong/PongBall.h

Timestamp:

Mar 23, 2011, 7:40:36 AM (14 years ago)

Author:

dafrick

Message:

Started documenting Pong.

File:

• code/branches/tetris/src/modules/pong/PongBall.h (modified) (2 diffs)

code/branches/tetris/src/modules/pong/PongBall.h

@@ -27 +27 @@
  */
 
+/**
+    @file PongBall.h
+    @brief Declaration of the PongBall class.
+    @ingroup Pong
+*/
+
 #ifndef _PongBall_H__
 #define _PongBall_H__
@@ -33 +39 @@
 
 #include "util/Math.h"
+
 #include "worldentities/MovableEntity.h"
 
 namespace orxonox
 {
+
+    /**
+    @brief
+        This class manages the ball for Pong.
+
+        //TODO: Describe what it's responnsibilities are.
+        Only moves in x-z area.
+
+    @author
+        Fabian 'x3n' Landau
+
+    @ingroup Pong
+    */
     class _PongExport PongBall : public MovableEntity
     {