Changeset 11099 for code/trunk/doc/api/groups/Pickup.dox

Timestamp:

Jan 27, 2016, 6:50:51 PM (8 years ago)

Author:

muemart

Message:

Fix loads of doxygen warnings and other documentation issues

File:

• code/trunk/doc/api/groups/Pickup.dox (modified) (1 diff)

code/trunk/doc/api/groups/Pickup.dox

@@ -151 +151 @@
 
     @subsection CreatingTheInnerWorkings Creating the inner workings of your pickup
+    @todo This is completely outdated. Someone who knows how pickups work should update this.
+    
     Now that we have the skeleton of a pickup and we have defined which carriers are allowed to pick our pickup up we are going to take a look at all the methods we can (or sometimes have to) overload from @ref orxonox::Pickupable "Pickupable", for our pickup to work properly. But first I will introduce some more concepts to make the need for these methods more obvious.
     - Since one pickup class can by itself be many pickup types, we need a way to find out whether a particular instance of a pickup is of the same type as another instance of a pickup. To that end the @ref orxonox::PickupIdentifier "PickupIdentifier" was created. The @ref orxonox::PickupIdentifier "PickupIdentifier" accounts for the type of class your pickup is of and also for the parameters (and their values) that distinguish different types of pickups of the same class. Much of the functionality of the pickup module relies on this identifier being correct, thus it is very important to initialize it correctly. (We will see, how that is done in a short while.)