documentation

[hbs.git] / bs / unittype.h

diff --git a/bs/unittype.h b/bs/unittype.h
index 895b03de4595fbaaaf559f516cd095a59392be6e..b01de80ef3c247107bfd3fb6b7c601aeef1a3f6f 100644 (file)
--- a/bs/unittype.h
+++ b/bs/unittype.h
@@ -94,16 +94,31 @@ public:
         */
        int      initiative() const;
 
-       /** Sets the agility, the higher it is the harder it is to hit the unit */
+       /** Used to set the agility, the higher it is the harder it is to hit the unit
+        * \param iAgil the agility represnted as an int
+        */
        void setAgility (int iAgil);
+       /** used to get this unittype's agility, higher is equal to hard to hit.
+        * \returns the agility as an int
+        */
        int  agility() const;
 
-       /** Sets the weaponspeed.. just a simple integer that shows how good it is at hitting things */
+       /** Used to set the weaponspeed.. Higher is equal to better at hitting
+        * \param iWPSP the weaponspeed represented as an int.
+        */
        void setWeaponSpeed(int iWPSP);
+       /** Used to get what weaponspeed this unittype has
+        * \returns the weaponspeed as an int
+        */
        int  weaponSpeed() const;
 
-       /** Sets the number of guns. */
+       /** Sets the number of guns for this unittype
+        * \param iGuns the number of guns represented as an int
+        */
        void setGuns(int iGuns);
+       /** used to get the number of guns this unittype has
+        * \returns the number of guns as an int
+        */
        int guns() const;
 
        /** Sets the how much power the guns have.. or in other words: the damage they do. */