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

Timestamp:

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

Author:

dafrick

Message:

Some more documentation.

File:

• code/trunk/src/modules/pickup/items/DronePickup.cc (modified) (5 diffs)

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

@@ -33 +33 @@
 
 #include "DronePickup.h"
-#include "worldentities/Drone.h"
-#include "controllers/DroneController.h"
+
+#include <sstream>
 
 #include "core/CoreIncludes.h"
@@ -40 +40 @@
 #include "util/StringUtils.h"
 
+#include "controllers/DroneController.h"
+#include "pickup/PickupIdentifier.h"
 #include "worldentities/pawns/Pawn.h"
-#include "pickup/PickupIdentifier.h"
-
-#include <sstream>
+#include "worldentities/Drone.h"
+#include "worldentities/StaticEntity.h"
 
 namespace orxonox
@@ -104 +105 @@
     }
 
+    /**
+    @brief
+        Set the droneTemplate.
+    @param templatename
+        The name of the Template to e set.
+    */
     void DronePickup::setDroneTemplate(std::string templatename){
         droneTemplate_ = templatename;
     }
 
+    /**
+    @brief
+        Get the name of the droneTemplate.
+    @return
+        Returns the name of the droneTemplate.
+    */
     const std::string& DronePickup::getDroneTemplate() const
     {
@@ -121 +134 @@
         SUPER(DronePickup, 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())
             return;
 
-        //! If the pickup has transited to used.
+        // If the pickup has transited to used.
         if(this->isUsed())
         {
 
                 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();
 
@@ -147 +160 @@
                 drone->setPosition(spawnPosition);
 
-                //! The pickup has been used up.
+                // The pickup has been used up.
                 this->setUsed(false);
         }
         else
         {
-            //! 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() ))
             {