Changeset 8855 for code/trunk/src/modules/weapons/projectiles/LightningGunProjectile.cc

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.cc (modified) (3 diffs)

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

@@ -27 +27 @@
  */
 
+/**
+    @file LightningGunProjectile.h
+    @brief Implementation of the LightningGunProjectile class.
+*/
+
 #include "LightningGunProjectile.h"
 
-#include "util/Convert.h"
 #include "core/CoreIncludes.h"
 #include "core/command/Executor.h"
+#include "util/Convert.h"
 
 namespace orxonox
@@ -53 +58 @@
     }
 
+    /**
+    @brief
+        Set the material.
+    @param material
+        The name of the material. Material names with 1 to 8 appended must exist.
+    */
     void LightningGunProjectile::setMaterial(const std::string& material)
     {
@@ -60 +71 @@
     }
 
+    /**
+    @brief
+        Change the texture.
+    */
     void LightningGunProjectile::changeTexture()
     {