Changeset 8855 for code/trunk/src/modules/weapons/weaponmodes/RocketFire.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/weaponmodes/RocketFire.h (modified) (3 diffs)

code/trunk/src/modules/weapons/weaponmodes/RocketFire.h

@@ -27 +27 @@
  */
 
+/**
+    @file RocketFire.h
+    @brief Definition of the RocketFire class.
+*/
+
 #ifndef _RocketFire_H__
 #define _RocketFire_H__
@@ -35 +40 @@
 namespace orxonox
 {
+
+    /**
+    @brief
+        Fires the (steerable) Rocket.
+    @author
+        Oliver Scheuss
+    @ingroup WeaponsWeaponModes
+    */
     class _WeaponsExport RocketFire : public WeaponMode
     {
@@ -44 +57 @@
 
         private:
-            float speed_;
+            float speed_; //!< The speed of the Rocket.
     };
 }