Changeset 6767 for code/branches/sound5/src/orxonox/weaponsystem

Timestamp:

Apr 20, 2010, 8:31:12 PM (15 years ago)

Author:

youngk

Message:

Added descriptions and missing documentation to the classes I edited last semester. Thanks!

Location:

code/branches/sound5/src/orxonox/weaponsystem

Files:

• WeaponMode.cc (modified) (1 diff)
• WeaponMode.h (modified) (2 diffs)

code/branches/sound5/src/orxonox/weaponsystem/WeaponMode.cc

@@ -24 +24 @@
  *      Fabian 'x3n' Landau
  *   Co-authors:
- *      ...
+ *      Kevin Young
  *
  */

code/branches/sound5/src/orxonox/weaponsystem/WeaponMode.h

@@ -24 +24 @@
  *      Fabian 'x3n' Landau
  *   Co-authors:
- *      ...
+ *      Kevin Young
  *
  */
@@ -41 +41 @@
 namespace orxonox
 {
+    /**
+     * The WeaponMode class enables the developer, amongst other things, to attach a sound file
+     * to the firing event of a weapon. The default firing sound is chosen by each weapon (ex.
+     * HsW01), hard-coded for now.
+     */
     class _OrxonoxExport WeaponMode : public BaseObject
     {