Changeset 2397 for code/branches/pickups2/src/orxonox/objects/pickup/ShipEquipment.h

Timestamp:

Dec 10, 2008, 8:24:53 PM (16 years ago)

Author:

dsommer

Message:

teilweise doxy geaddet und weitere test instanzen

File:

• code/branches/pickups2/src/orxonox/objects/pickup/ShipEquipment.h (modified) (2 diffs)

code/branches/pickups2/src/orxonox/objects/pickup/ShipEquipment.h

@@ -18 +18 @@
 {
     class Item;
+/**
+@brief
+    ShipEquipment is the inventory of a player. It's part of the Pawn class.
 
+*/
     class _OrxonoxExport ShipEquipment
     {
@@ -40 +44 @@
         {this->player = setplayer;}
         private:
-            Pawn* player;
-            std::multimap<std::string, Item*> Equipment;
-            std::multimap<std::string, Item*> Usable;
-            std::multimap<std::string, Item*> Trunk;
+            Pawn* player;//!< Is a pointer to the belonging player
+            std::multimap<std::string, Item*> Equipment;//!< the Equipment for permanent Items
+            std::multimap<std::string, Item*> Usable;//!< Where Usables are stored
+            std::multimap<std::string, Item*> Trunk;//!< Every other Item is stored here
     };
 }