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

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

@@ -27 +27 @@
  */
 
+/**
+    @file LightningGunProjectile.h
+    @brief Definition of the LightningGunProjectile class.
+*/
+
 #ifndef _LightningGunProjectile_H__
 #define _LightningGunProjectile_H__
@@ -38 +43 @@
 namespace orxonox
 {
+
+    /**
+    @brief
+        The LightningGunProjectile is a projectile that is represented by a looped series of billboards.
+        
+    @author
+        Joel Smely
+    @ingroup WeaponsProjectiles
+    */
     class _WeaponsExport LightningGunProjectile : public BillboardProjectile
     {
@@ -46 +60 @@
             virtual void setMaterial(const std::string& material);
 
-        protected:
+        private:
+            void registerVariables();
             void changeTexture();
-            unsigned int textureIndex_;
-            unsigned int maxTextureIndex_;
-            Timer textureTimer_;
-            std::string materialBase_;
-      private:
-            void registerVariables();
+            
+            unsigned int textureIndex_; //!< The current index of the texture. (i.e. the index of the currently displayed texture)
+            unsigned int maxTextureIndex_; //!< The maximal index.
+            Timer textureTimer_; //!< A timer that loops and changes textures each time it expires.
+            std::string materialBase_; //!< The base name of the material.
     };
 }