Changeset 6538 for code/trunk/src/orxonox/interfaces

Timestamp:

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

Author:

dafrick

Message:

Done some (almost final) documenting in pickup module.

Location:

code/trunk/src/orxonox/interfaces

Files:

• Pickupable.cc (modified) (7 diffs)
• Pickupable.h (modified) (3 diffs)

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

@@ -28 +28 @@
 
 /**
-    @file
+    @file Pickupable.cc
     @brief Implementation of the Pickupable class.
 */
@@ -96 +96 @@
     /**
     @brief
-        Get whether the given PickupCarrier is a target of this pickup.
+        Get whether the given PickupCarrier is a target of this Pickupable.
     @param carrier
-        The PickupCarrier of which it has to be determinde whether it is a target of this pickup.
+        The PickupCarrier of which it has to be determinde whether it is a target of this Pickupable.
     @return
         Returns true if the given PickupCarrier is a target.
@@ -109 +109 @@
     /**
     @brief
-        Get whether a given class, represented by the input Identifier, is a target of this pickup.
+        Get whether a given class, represented by the input Identifier, is a target of this Pickupable.
     @param target
-        The Identifier of which it has to be determinde whether it is a target of this pickup.
+        The Identifier of which it has to be determinde whether it is a target of this Pickupable.
     @return
         Returns true if the given Identifier is a target.
@@ -128 +128 @@
     /**
     @brief
-        Add a PickupCarrier as target of this pickup.
+        Add a PickupCarrier as target of this Pickupable.
     @param target
         The PickupCarrier to be added.
@@ -141 +141 @@
     /**
     @brief
-        Add a class, representetd by the input Identifier, as target of this pickup.
+        Add a class, representetd by the input Identifier, as target of this Pickupable.
     @param target
         The Identifier to be added.
@@ -199 +199 @@
     /**
     @brief
-        Sets the carrier of the pickup.
+        Sets the carrier of the Pickupable.
     @param carrier
         Sets the input PickupCarrier as the carrier of the pickup.
@@ -265 +265 @@
         This method needs to be implemented by any Class inheriting from Pickupable.
     @param item
-        A pointer to the OrxonoxClass that is to be duplicated.
+        A reference to a pointer to the OrxonoxClass that is to be duplicated.
     */
     //TODO: Specify how the implementation must be done in detail.

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) {}