Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

Ignore:
Timestamp:
Dec 7, 2015, 2:26:27 PM (9 years ago)
Author:
bucyril
Message:

Added documentation

Location:
code/branches/hoverHS15/src/modules/hover
Files:
6 edited

Legend:

Unmodified
Added
Removed

  • code/branches/hoverHS15/src/modules/hover/FlagHUD.cc

    r10900 r10929  
    2424 *
    2525 */
     26
     27/**
     28    @file FlagHUD.cc
     29    @brief Implementation of the FlagHUD
     30*/
    2631
    2732#include "FlagHUD.h"
    … …  
    5156    }
    5257
     58/**
     59    @brief Sets the amount of flags displayed, once zero it does not reappear
     60    @param flagCount
     61*/
    5362    void FlagHUD::setFlagCount(int flagCount) {
    5463        if(flagCount == 0){

  • code/branches/hoverHS15/src/modules/hover/FlagHUD.h

    r10900 r10929  
    2424 *
    2525 */
     26
     27 /**
     28    @file FlagHUD.h
     29    @brief Declaration of the FlagHUD class.
     30*/
    2631
    2732#ifndef _FlagHUD_H__

  • code/branches/hoverHS15/src/modules/hover/HoverShip.cc

    r10784 r10929  
    2222 *   Author:
    2323 *      Cyrill Burgener
    24  *   Co-authors:
    25  *      ...
    2624 *
    2725 */
    … …  
    2927/**
    3028    @file HoverShip.cc
    31     @brief Implementation of the HoverShip class.
     29    @brief Implementation of the HoverShip control
    3230*/
    3331
    … …  
    7472    }
    7573
    76 
     74    /**
     75    @brief
     76        sets this ships jumpBoost
     77    @param jumpBoost
     78    */
    7779    void HoverShip::setJumpBoost(float jumpBoost)
    7880    {
    … …  
    8082    }
    8183
    82 
     84    /**
     85    @brief
     86        returns this ships jumpBoost
     87    @returns jumpBoost
     88    */
    8389    float HoverShip::getJumpBoost()
    8490    {
    … …  
    8894    /**
    8995    @brief
    90         Rotate in pitch direction.
    91         Due to added left, can also lead to an additional up-down motion.
     96        Removed, does nothing.
    9297    @param value
    93         A vector whose first component specifies the magnitude of the rotation. Positive means pitch up, negative means pitch down.
    9498    */
    9599    void HoverShip::rotatePitch(const Vector2& value) { }
    … …  
    97101    /**
    98102    @brief
    99         Rotate in roll direction.
     103        Removed, does nothing.
    100104    @param value
    101         A vector whose first component specifies the magnitude of the rotation. Positive means roll left, negative means roll right.
    102105    */
    103106    void HoverShip::rotateRoll(const Vector2& value) { }
    104107
     108    /**
     109    @brief
     110        Checks if the ship is touching the floor. The ship can only jump if there is contact with someting beneath it.
     111    */
    105112    bool HoverShip::collidesAgainst(WorldEntity* otherObject, const btCollisionShape* cs, btManifoldPoint& contactPoint)
    106113    {
    … …  
    118125    }
    119126
     127    /**
     128    @brief
     129        Makes the ship jump
     130    @param bBoost
     131    */
    120132    void HoverShip::boost(bool bBoost) {
    121133        if (bBoost && this->isFloor_)
    … …  
    129141        }
    130142    }
    131 
    132     /*Hover* HoverShip::getGame()
    133     {
    134         if (game == NULL)
    135         {
    136             for (ObjectList<Hover>::iterator it = ObjectList<Hover>::begin(); it != ObjectList<Hover>::end(); ++it)
    137             {
    138                 game = *it;
    139             }
    140         }
    141         return game;
    142     }*/
    143143}

  • code/branches/hoverHS15/src/modules/hover/HoverShip.h

    r10784 r10929  
    2222 *   Author:
    2323 *      Cyrill Burgener
    24  *   Co-authors:
    25  *      ...
    2624 *
    2725 */
    … …  
    4341#include "graphics/Camera.h"
    4442#include "core/class/Super.h"
    45 
    46 #include "Hover.h" // Is necessary for getGame function
    4743
    4844namespace orxonox

  • code/branches/hoverHS15/src/modules/hover/TimeHUD.cc

    r10900 r10929  
    2424 *
    2525 */
     26
     27/**
     28    @file TimeHUD.cc
     29    @brief Implementation of the TimeHUD
     30*/
     31
    2632
    2733#include "TimeHUD.h"
    … …  
    102108    }
    103109
     110    /**
     111    @brief
     112        sets if the clock is running
     113    @param running
     114    */
    104115    void TimeHUD::setRunning(bool running)
    105116    {
    … …  
    107118    }
    108119
     120    /**
     121    @brief
     122        returns if the clock is running
     123    @returns running
     124    */
    109125    bool TimeHUD::isRunning() {
    110126        return this->_running;

  • code/branches/hoverHS15/src/modules/hover/TimeHUD.h

    r10895 r10929  
    2424 *
    2525 */
     26
     27 /**
     28    @file TimeHUD.h
     29    @brief Declaration of the TimeHUD class.
     30*/
    2631
    2732#ifndef _TimeHUD_H__
Note: See TracChangeset for help on using the changeset viewer.