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

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.cc (modified) (4 diffs)

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

@@ -6 +6 @@
 namespace orxonox
 {
+/**
+@brief
+    Insert a permanent Item to the Equipment. Is usually called by the addTo function in Items.
+    
+@param item
+    pointer to the item which is to be inserted.
 
+@return
+    if new item has sucessfully been added it will return true, in any other case the return value is false.
+*/
         bool ShipEquipment::insert(Item* item)
         {
@@ -17 +26 @@
         {
                 COUT(3) << "SWAP?" <<  endl;
+                //Abfrage- irgendne ifschleife... 
                 if((checkSlot(item)->dropped(player))==true);
                 {
@@ -28 +38 @@
         return false;
         };
+
+/**
+@brief
+    Erases a permanent Item in the Equipment. Is usually called by the remove/dropped function in Items.
+    
+@param item
+    pointer to the item which is to be erased.
+
+@return
+    if new item has sucessfully been erased it will return true, in any other case the return value is false.
+*/
         bool ShipEquipment::erase (Item* item)
         {
@@ -46 +67 @@
 
         }*/
+/**
+@brief
+    Erases all permanent Items in the Equipment. Its Triggered by hitting the L button.
+
+*/
         void ShipEquipment::eraseAll()
         {