Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

Ignore:
Timestamp:
Aug 22, 2011, 3:05:26 PM (13 years ago)
Author:
dafrick
Message:

Cleaning up game immersion. Roughly documenting weapons module.

Location:
code/trunk/src/modules/weapons/munitions
Files:
8 edited

Legend:

Unmodified
Added
Removed

  • code/trunk/src/modules/weapons/munitions/FusionMunition.cc

    r5781 r8855  
    2727 */
    2828
     29/**
     30    @file FusionMunition.h
     31    @brief Implementation of the FusionMunition class.
     32*/
     33
    2934#include "FusionMunition.h"
    3035#include "core/CoreIncludes.h"

  • code/trunk/src/modules/weapons/munitions/FusionMunition.h

    r5781 r8855  
    2727 */
    2828
     29/**
     30    @file FusionMunition.h
     31    @brief Definition of the FusionMunition class.
     32*/
     33
    2934#ifndef _FusionMunition_H__
    3035#define _FusionMunition_H__
    … …  
    3540namespace orxonox
    3641{
     42
     43    /**
     44    @brief
     45        FusionMunition.
     46    @author
     47        Martin Polak
     48    @ingroup WeaponsMunitions
     49    */
    3750    class _WeaponsExport FusionMunition : public Munition
    3851    {

  • code/trunk/src/modules/weapons/munitions/LaserMunition.cc

    r5781 r8855  
    2727 */
    2828
     29/**
     30    @file LaserMunition.h
     31    @brief Implementation of the LaserMunition class.
     32*/
     33
    2934#include "LaserMunition.h"
    3035#include "core/CoreIncludes.h"
    … …  
    4853        this->bAllowMultiMunitionRemovementUnderflow_ = true;
    4954
    50         this->replenishIntervall_ = 0.5f;
     55        this->replenishInterval_ = 0.5f;
    5156        this->replenishMunitionAmount_ = 1;
    5257    }

  • code/trunk/src/modules/weapons/munitions/LaserMunition.h

    r5781 r8855  
    2727 */
    2828
     29/**
     30    @file LaserMunition.h
     31    @brief Definition of the LaserMunition class.
     32*/
     33
    2934#ifndef _LaserMunition_H__
    3035#define _LaserMunition_H__
    … …  
    3540namespace orxonox
    3641{
     42
     43    /**
     44    @brief
     45        LaserMunition.
     46    @author
     47        Martin Polak
     48    @ingroup WeaponsMunitions
     49    */
    3750    class _WeaponsExport LaserMunition : public ReplenishingMunition
    3851    {

  • code/trunk/src/modules/weapons/munitions/ReplenishingMunition.cc

    r8729 r8855  
    2727 */
    2828
     29/**
     30    @file ReplenishingMunition.h
     31    @brief Implementation of the ReplenishingMunition class.
     32*/
     33
    2934#include "ReplenishingMunition.h"
    3035
    … …  
    4045        RegisterObject(ReplenishingMunition);
    4146
    42         this->replenishIntervall_ = 1.0f;
     47        this->replenishInterval_ = 1.0f;
    4348        this->replenishMunitionAmount_ = 1;
    4449
    … …  
    5257    {
    5358        // Initialize the timer
    54         this->replenishingTimer_.setTimer(this->replenishIntervall_, true, createExecutor(createFunctor(&ReplenishingMunition::replenish, this)));
     59        this->replenishingTimer_.setTimer(this->replenishInterval_, true, createExecutor(createFunctor(&ReplenishingMunition::replenish, this)));
    5560    }
    5661

  • code/trunk/src/modules/weapons/munitions/ReplenishingMunition.h

    r5929 r8855  
    2727 */
    2828
     29/**
     30    @file ReplenishingMunition.h
     31    @brief Definition of the ReplenishingMunition class.
     32*/
     33
    2934#ifndef _ReplenishingMunition_H__
    3035#define _ReplenishingMunition_H__
    … …  
    3742namespace orxonox
    3843{
     44
     45    /**
     46    @brief
     47        Munition that is replenished by a certain amount each time interval.
     48    @author
     49        Fabian 'x3n' Landau
     50    @ingroup WeaponsMunitions
     51    */
    3952    class _WeaponsExport ReplenishingMunition : public Munition
    4053    {
    … …  
    4457
    4558        protected:
    46             float replenishIntervall_;
    47             unsigned int replenishMunitionAmount_;
     59            float replenishInterval_; //!< The interval in which the munition is replenished.
     60            unsigned int replenishMunitionAmount_; //!< The amount by which it is replenished.
    4861
    4962        private:
    … …  
    5164            void initializeTimer();
    5265
    53             Timer replenishingTimer_;
     66            Timer replenishingTimer_; //!< Timer to do the replenishing.
    5467    };
    5568}

  • code/trunk/src/modules/weapons/munitions/RocketMunition.cc

    r7896 r8855  
    2727 */
    2828
     29/**
     30    @file RocketMunition.h
     31    @brief Implementation of the RocketMunition class.
     32*/
     33
    2934#include "RocketMunition.h"
    3035#include "core/CoreIncludes.h"

  • code/trunk/src/modules/weapons/munitions/RocketMunition.h

    r7846 r8855  
    2727 */
    2828
     29/**
     30    @file RocketMunition.h
     31    @brief Definition of the RocketMunition class.
     32*/
     33
    2934#ifndef _RocketMunition_H__
    3035#define _RocketMunition_H__
    … …  
    3540namespace orxonox
    3641{
     42
     43    /**
     44    @brief
     45        Munition for the Rocket.
     46    @author
     47        Fabian 'x3n' Landau
     48    @ingroup WeaponsMunitions
     49    */
    3750    class _WeaponsExport RocketMunition : public Munition
    3851    {
Note: See TracChangeset for help on using the changeset viewer.