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

code/trunk/src/modules/weapons/MuzzleFlash.h

@@ -27 +27 @@
  */
 
+/**
+    @file MuzzleFlash.h
+    @brief Definition of the MuzzleFlash class.
+*/
+
 #ifndef _MuzzleFlash_H__
 #define _MuzzleFlash_H__
@@ -37 +42 @@
 namespace orxonox
 {
+
+    /**
+    @brief
+        A muzzle flash that destroys itself after some time.
+    @author
+        Hagen Seifert
+    @ingroup Weapons
+    @todo
+        Remove because it's unused?
+    */
     class _WeaponsExport MuzzleFlash : public Billboard
     {
@@ -44 +59 @@
 
         private:
-            Timer delayTimer_;
+            Timer delayTimer_; //!< Timer to destroy the object.
     };
 }