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

code/trunk/src/modules/weapons/projectiles/ParticleProjectile.h

@@ -27 +27 @@
  */
 
+/**
+    @file ParticleProjectile.h
+    @brief Definition of the ParticleProjectile class.
+*/
+
 #ifndef _ParticleProjectile_H__
 #define _ParticleProjectile_H__
@@ -35 +40 @@
 namespace orxonox
 {
+
+    /**
+    @brief
+        A projectile that is represented by particles.
+    @author
+        Fabian 'x3n' Landau
+    @ingroup WeaponsProjectiles
+    */
     class _WeaponsExport ParticleProjectile : public BillboardProjectile
     {
@@ -43 +56 @@
 
         private:
-            ParticleInterface* particles_;
+            ParticleInterface* particles_; //!< The particles.
     };
 }