Changeset 6519 for code/branches/pickup3/src/modules/pickup/items

Timestamp:

Mar 13, 2010, 3:32:34 PM (15 years ago)

Author:

dafrick

Message:

Started documenting MetaPcikup, resolved some bugs in PickupCollection and PickupCollectionIdentifier.

Location:

code/branches/pickup3/src/modules/pickup/items

Files:

• MetaPickup.cc (modified) (2 diffs)
• MetaPickup.h (modified) (3 diffs)

code/branches/pickup3/src/modules/pickup/items/MetaPickup.cc

@@ -27 +27 @@
 */
 
+/**
+    @file
+    @brief Implementation of the MetaPickup class.
+*/
+
 #include "core/CoreIncludes.h"
 #include "core/XMLPort.h"
@@ -42 +47 @@
     /*static*/ const std::string MetaPickup::metaTypeDrop_s = "drop";
     
+    /**
+    @brief
+        Constructor. 
+    */
     MetaPickup::MetaPickup(BaseObject* creator) : Pickup(creator)
     {

code/branches/pickup3/src/modules/pickup/items/MetaPickup.h

@@ -27 +27 @@
 */
 
+/**
+    @file
+    @brief Definition of the MetaPickup class.
+*/
+
 #ifndef _MetaPickup_H__
 #define _MetaPickup_H__
@@ -36 +41 @@
 namespace orxonox {
 
+    //! The meta type, deciding what the pickup does exactly.
     namespace pickupMetaType
     {
@@ -46 +52 @@
     }
     
+    /**
+    @brief
+        The MetaPickup is a pickup that can, depending on the parameters, either drop all pickups of the PickupCarrier that picks it up, or use all the unused pickups of the PickupCarrier, that picks it up. The parameter to set for this is the metaType and it can be used with the values 'none', 'drop' and 'use'.
+    @author
+        Damian 'Mozork' Frick
+    */
     class _PickupExport MetaPickup : public Pickup
     {
-        friend class PickupCarrier;
         
         public: