[Orxonox-commit 3862] r8536 - code/branches/pickup/src/modules/pickup/items

[ssgier at orxonox.net]

Author: ssgier
Date: 2011-05-23 14:52:25 +0200 (Mon, 23 May 2011)
New Revision: 8536

Modified:
   code/branches/pickup/src/modules/pickup/items/ShrinkPickup.h
Log:
added comments

Modified: code/branches/pickup/src/modules/pickup/items/ShrinkPickup.h
===================================================================
--- code/branches/pickup/src/modules/pickup/items/ShrinkPickup.h	2011-05-23 12:39:49 UTC (rev 8535)
+++ code/branches/pickup/src/modules/pickup/items/ShrinkPickup.h	2011-05-23 12:52:25 UTC (rev 8536)
@@ -52,6 +52,30 @@
 
     @ingroup PickupItems
     */
+
+    /**
+    @brief
+        The ShrinkPickup is a Pickupable that causes the pawn to shrink to a certain size for a certain time with a certain speed, all of them specified in the following variables:
+        - The @b shrinkFactor It determines how much the ship is going to shrink (e.g. the factor 2 would make the ship shrinking to half its size).
+        - The @b duration Specifies how long the ship will keep small.
+        - The @b shrinkSpeed Defines how fast the ship shrinks and grows.
+
+
+        An example of a XML implementation of a HealthPickup would be:
+        @code
+        <HealthPickup
+            shrinkFactor = "5.0"
+            duration = "5.0"
+            shrinkSpeed = "5.0"
+        />
+        @endcode
+
+    @author
+        Sandro Sgier
+
+    @ingroup PickupItems
+    */
+
     class _PickupExport ShrinkPickup : public Pickup, public Tickable
     {
         public: