Changeset 11099 for code/trunk/src/modules/weapons

Timestamp:

Jan 27, 2016, 6:50:51 PM (9 years ago)

Author:

muemart

Message:

Fix loads of doxygen warnings and other documentation issues

Location:

code/trunk/src/modules/weapons

Files:

• projectiles/BasicProjectile.cc (modified) (1 diff)
• projectiles/BasicProjectile.h (modified) (1 diff)
• projectiles/GravityBombField.h (modified) (1 diff)
• projectiles/SplitGunProjectile.cc (modified) (1 diff)
• weaponmodes/HsW01.h (modified) (1 diff)

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

@@ -74 +74 @@
     @param contactPoint
         A btManifoldPoint indicating the point of contact/impact.
+    @param cs
+        The btCollisionShape of the other object
     @return
         Returns true if the collision resulted in a successful hit.

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

@@ -97 +97 @@
             /**
             @brief Get the shield-damage done by this projectile.
-                   Shield-damage only reduces shield health.
-            @param shielddamage The amount of damage. Is non-negative.
             */
             inline float getShieldDamage() const

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

@@ -50 +50 @@
      * @date    23.05.2015
      *
-     * @param [in,out]  the Pawn that created the field.
+     * @param [in,out] shooter the Pawn that created the field.
      */
     void setShooter(Pawn* shooter)

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

@@ -80 +80 @@
     /**
     @brief
-        This function starts a timer that will cause the projectile to split after a time defined by the argument @param splitTime.        
+        This function starts a timer that will cause the projectile to split after a time defined by the argument @p splitTime.
+    @param splitTime The time
     */
     void SplitGunProjectile::setSplitTime(float splitTime)

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

@@ -76 +76 @@
             /**
             @brief Set the sound.
-            @param mesh The Sound name.
+            @param sound The Sound name.
             */
             void setSound(const std::string& sound)