Changeset 7297 for code/branches/doc/src/orxonox/interfaces/Pickupable.h

Timestamp:

Aug 31, 2010, 8:37:29 PM (14 years ago)

Author:

landauf

Message:

fixed lots of Doxygen warnings

Note: Doxygen prints a warning if only a part of the parameters of a function are documented.

Added documentation for missing parameters (as good as I could), removed documentation of obsolete parameters and fixed names of renamed parameters.
Some parameters are tagged with "FIXME", please replace this with an appropriate documentation if you know what it does.

File:

• code/branches/doc/src/orxonox/interfaces/Pickupable.h (modified) (1 diff)

code/branches/doc/src/orxonox/interfaces/Pickupable.h

@@ -162 +162 @@
                    This method must be implemented by any class directly inheriting from Pickupable. It is most easily done by just creating a new DroppedPickup, e.g.:
                    DroppedPickup(BaseObject* creator, Pickupable* pickup, PickupCarrier* carrier, float triggerDistance);
-            @param position The position at which the PickupSpawner should be placed.
             @return Returns true if a spawner was created, false if not.
             */