[Orxonox-commit 6272] r10929 - code/branches/hoverHS15/src/modules/hover

[bucyril at orxonox.net]

Author: bucyril
Date: 2015-12-07 14:26:27 +0100 (Mon, 07 Dec 2015)
New Revision: 10929

Modified:
   code/branches/hoverHS15/src/modules/hover/FlagHUD.cc
   code/branches/hoverHS15/src/modules/hover/FlagHUD.h
   code/branches/hoverHS15/src/modules/hover/HoverShip.cc
   code/branches/hoverHS15/src/modules/hover/HoverShip.h
   code/branches/hoverHS15/src/modules/hover/TimeHUD.cc
   code/branches/hoverHS15/src/modules/hover/TimeHUD.h
Log:
Added documentation


Modified: code/branches/hoverHS15/src/modules/hover/FlagHUD.cc
===================================================================
--- code/branches/hoverHS15/src/modules/hover/FlagHUD.cc	2015-12-07 13:05:58 UTC (rev 10928)
+++ code/branches/hoverHS15/src/modules/hover/FlagHUD.cc	2015-12-07 13:26:27 UTC (rev 10929)
@@ -24,6 +24,11 @@
  *
  */
 
+/**
+    @file FlagHUD.cc
+    @brief Implementation of the FlagHUD
+*/
+
 #include "FlagHUD.h"
 
 #include <OgreOverlayManager.h>
@@ -50,6 +55,10 @@
         setFlagCount(5);
     }
 
+/**
+    @brief Sets the amount of flags displayed, once zero it does not reappear
+    @param flagCount
+*/
     void FlagHUD::setFlagCount(int flagCount) {
         if(flagCount == 0){
             this->panel_->hide();

Modified: code/branches/hoverHS15/src/modules/hover/FlagHUD.h
===================================================================
--- code/branches/hoverHS15/src/modules/hover/FlagHUD.h	2015-12-07 13:05:58 UTC (rev 10928)
+++ code/branches/hoverHS15/src/modules/hover/FlagHUD.h	2015-12-07 13:26:27 UTC (rev 10929)
@@ -24,6 +24,11 @@
  *
  */
 
+ /**
+    @file FlagHUD.h
+    @brief Declaration of the FlagHUD class.
+*/
+
 #ifndef _FlagHUD_H__
 #define _FlagHUD_H__
 

Modified: code/branches/hoverHS15/src/modules/hover/HoverShip.cc
===================================================================
--- code/branches/hoverHS15/src/modules/hover/HoverShip.cc	2015-12-07 13:05:58 UTC (rev 10928)
+++ code/branches/hoverHS15/src/modules/hover/HoverShip.cc	2015-12-07 13:26:27 UTC (rev 10929)
@@ -21,14 +21,12 @@
  *
  *   Author:
  *      Cyrill Burgener
- *   Co-authors:
- *      ...
  *
  */
 
 /**
     @file HoverShip.cc
-    @brief Implementation of the HoverShip class.
+    @brief Implementation of the HoverShip control
 */
 
 #include "HoverShip.h"
@@ -73,13 +71,21 @@
         XMLPortParam(HoverShip, "jumpBoost", setJumpBoost, getJumpBoost, xmlelement, mode);
     }
 
-
+    /**
+    @brief
+        sets this ships jumpBoost
+    @param jumpBoost
+    */
     void HoverShip::setJumpBoost(float jumpBoost)
     {
         this->jumpBoost_ = jumpBoost;
     }
 
-
+    /**
+    @brief
+        returns this ships jumpBoost
+    @returns jumpBoost
+    */
     float HoverShip::getJumpBoost()
     {
         return jumpBoost_;
@@ -87,21 +93,22 @@
 
     /**
     @brief
-        Rotate in pitch direction.
-        Due to added left, can also lead to an additional up-down motion.
+        Removed, does nothing.
     @param value
-        A vector whose first component specifies the magnitude of the rotation. Positive means pitch up, negative means pitch down.
     */
     void HoverShip::rotatePitch(const Vector2& value) { }
 
     /**
     @brief
-        Rotate in roll direction.
+        Removed, does nothing.
     @param value
-        A vector whose first component specifies the magnitude of the rotation. Positive means roll left, negative means roll right.
     */
     void HoverShip::rotateRoll(const Vector2& value) { }
 
+    /**
+    @brief
+        Checks if the ship is touching the floor. The ship can only jump if there is contact with someting beneath it.
+    */
     bool HoverShip::collidesAgainst(WorldEntity* otherObject, const btCollisionShape* cs, btManifoldPoint& contactPoint)
     {
         SpaceShip::collidesAgainst(otherObject, cs, contactPoint);
@@ -117,6 +124,11 @@
         return false;
     }
 
+    /**
+    @brief
+        Makes the ship jump
+    @param bBoost
+    */
     void HoverShip::boost(bool bBoost) {
         if (bBoost && this->isFloor_)
         {
@@ -128,16 +140,4 @@
             this->isFloor_ = false;
         }
     }
-
-    /*Hover* HoverShip::getGame()
-    {
-        if (game == NULL)
-        {
-            for (ObjectList<Hover>::iterator it = ObjectList<Hover>::begin(); it != ObjectList<Hover>::end(); ++it)
-            {
-                game = *it;
-            }
-        }
-        return game;
-    }*/
 }

Modified: code/branches/hoverHS15/src/modules/hover/HoverShip.h
===================================================================
--- code/branches/hoverHS15/src/modules/hover/HoverShip.h	2015-12-07 13:05:58 UTC (rev 10928)
+++ code/branches/hoverHS15/src/modules/hover/HoverShip.h	2015-12-07 13:26:27 UTC (rev 10929)
@@ -21,8 +21,6 @@
  *
  *   Author:
  *      Cyrill Burgener
- *   Co-authors:
- *      ...
  *
  */
 
@@ -43,8 +41,6 @@
 #include "graphics/Camera.h"
 #include "core/class/Super.h"
 
-#include "Hover.h" // Is necessary for getGame function
-
 namespace orxonox
 {
     class _HoverExport HoverShip : public SpaceShip

Modified: code/branches/hoverHS15/src/modules/hover/TimeHUD.cc
===================================================================
--- code/branches/hoverHS15/src/modules/hover/TimeHUD.cc	2015-12-07 13:05:58 UTC (rev 10928)
+++ code/branches/hoverHS15/src/modules/hover/TimeHUD.cc	2015-12-07 13:26:27 UTC (rev 10929)
@@ -24,6 +24,12 @@
  *
  */
 
+/**
+    @file TimeHUD.cc
+    @brief Implementation of the TimeHUD
+*/
+
+
 #include "TimeHUD.h"
 
 #include "core/CoreIncludes.h"
@@ -101,11 +107,21 @@
         }
     }
 
+    /**
+    @brief
+        sets if the clock is running
+    @param running
+    */
     void TimeHUD::setRunning(bool running) 
     {
         this->_running = running;
     }
 
+    /**
+    @brief
+        returns if the clock is running
+    @returns running
+    */
     bool TimeHUD::isRunning() {
         return this->_running;
     }

Modified: code/branches/hoverHS15/src/modules/hover/TimeHUD.h
===================================================================
--- code/branches/hoverHS15/src/modules/hover/TimeHUD.h	2015-12-07 13:05:58 UTC (rev 10928)
+++ code/branches/hoverHS15/src/modules/hover/TimeHUD.h	2015-12-07 13:26:27 UTC (rev 10929)
@@ -24,6 +24,11 @@
  *
  */
 
+ /**
+    @file TimeHUD.h
+    @brief Declaration of the TimeHUD class.
+*/
+
 #ifndef _TimeHUD_H__
 #define _TimeHUD_H__