Changeset 6538 for code/trunk/src/orxonox/interfaces/Pickupable.h

Timestamp:

Mar 16, 2010, 6:15:45 PM (14 years ago)

Author:

dafrick

Message:

Done some (almost final) documenting in pickup module.

File:

• code/trunk/src/orxonox/interfaces/Pickupable.h (modified) (3 diffs)

code/trunk/src/orxonox/interfaces/Pickupable.h

@@ -28 +28 @@
 
 /**
-    @file
+    @file Pickupable.h
     @brief Definition of the Pickupable class.
 */
@@ -100 +100 @@
             
             bool isTarget(const PickupCarrier* carrier) const; //!< Get whether the given PickupCarrier is a target of this pickup.
-            virtual bool isTarget(Identifier* identifier) const; //!< Get whether a given class, represented by the input Identifier, is a target of this pickup.
+            virtual bool isTarget(Identifier* identifier) const; //!< Get whether a given class, represented by the input Identifier, is a target of this Pickupable.
             bool addTarget(PickupCarrier* target); //!< Add a PickupCarrier as target of this pickup.
             bool addTarget(Identifier* identifier); //!< Add a class, representetd by the input Identifier, as target of this pickup.
@@ -123 +123 @@
             @brief Helper method to initialize the PickupIdentifier.
             */
-            //TODO: Really needed?
             void initializeIdentifier(void) {}