Changeset 7541 for code/trunk/src/modules/pickup/items/HealthPickup.cc

Timestamp:

Oct 14, 2010, 12:55:59 PM (14 years ago)

Author:

dafrick

Message:

Some more documentation.

File:

• code/trunk/src/modules/pickup/items/HealthPickup.cc (modified) (6 diffs)

code/trunk/src/modules/pickup/items/HealthPickup.cc

@@ -142 +142 @@
         {
             Pawn* pawn = this->carrierToPawnHelper();
-            if(pawn == NULL) //!< If the PickupCarrier is no Pawn, then this pickup is useless and therefore is destroyed.
+            if(pawn == NULL) // If the PickupCarrier is no Pawn, then this pickup is useless and therefore is destroyed.
                 this->Pickupable::destroy();
 
-            //! Calculate the health that is added this tick.
+            // Calculate the health that is added this tick.
             float health = dt*this->getHealthRate();
             if(health > this->getHealth())
                 health = this->getHealth();
-            //! Calculate the health the Pawn will have once the health is added.
+            // Calculate the health the Pawn will have once the health is added.
             float fullHealth = pawn->getHealth() + health;
             this->setHealth(this->getHealth()-health);
@@ -174 +174 @@
             }
 
-            //! If all health has been transfered.
+            // If all health has been transferred.
             if(this->getHealth() == 0)
             {
@@ -190 +190 @@
         SUPER(HealthPickup, changedUsed);
 
-        //! If the pickup is not picked up nothing must be done.
+        // If the pickup is not picked up nothing must be done.
         if(!this->isPickedUp()) //TODO: Needed?
             return;
 
-        //! If the pickup has transited to used.
+        // If the pickup has transited to used.
         if(this->isUsed())
         {
@@ -200 +200 @@
             {
                 Pawn* pawn = this->carrierToPawnHelper();
-                if(pawn == NULL) //!< If the PickupCarrier is no Pawn, then this pickup is useless and therefore is destroyed.
+                if(pawn == NULL) // If the PickupCarrier is no Pawn, then this pickup is useless and therefore is destroyed.
                     this->Pickupable::destroy();
 
@@ -227 +227 @@
                 }
 
-                //! The pickup has been used up.
+                // The pickup has been used up.
                 this->setUsed(false);
             }
@@ -253 +253 @@
             }
 
-            //! If either the pickup can only be used once or it is continuous and used up, it is destroyed upon setting it to unused.
+            // If either the pickup can only be used once or it is continuous and used up, it is destroyed upon setting it to unused.
             if(this->isOnce() || (this->isContinuous() && this->getHealth() == 0))
             {