Changeset 8855 for code/trunk/src/modules/weapons/munitions/ReplenishingMunition.h

Timestamp:

Aug 22, 2011, 3:05:26 PM (13 years ago)

Author:

dafrick

Message:

Cleaning up game immersion. Roughly documenting weapons module.

File:

• code/trunk/src/modules/weapons/munitions/ReplenishingMunition.h (modified) (4 diffs)

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

@@ -27 +27 @@
  */
 
+/**
+    @file ReplenishingMunition.h
+    @brief Definition of the ReplenishingMunition class.
+*/
+
 #ifndef _ReplenishingMunition_H__
 #define _ReplenishingMunition_H__
@@ -37 +42 @@
 namespace orxonox
 {
+
+    /**
+    @brief
+        Munition that is replenished by a certain amount each time interval.
+    @author
+        Fabian 'x3n' Landau
+    @ingroup WeaponsMunitions
+    */
     class _WeaponsExport ReplenishingMunition : public Munition
     {
@@ -44 +57 @@
 
         protected:
-            float replenishIntervall_;
-            unsigned int replenishMunitionAmount_;
+            float replenishInterval_; //!< The interval in which the munition is replenished.
+            unsigned int replenishMunitionAmount_; //!< The amount by which it is replenished.
 
         private:
@@ -51 +64 @@
             void initializeTimer();
 
-            Timer replenishingTimer_;
+            Timer replenishingTimer_; //!< Timer to do the replenishing.
     };
 }