Changeset 7297 for code/branches/doc/src/modules/pickup

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.

Location:

code/branches/doc/src/modules/pickup

Files:

• DroppedPickup.cc (modified) (1 diff)
• Pickup.cc (modified) (1 diff)
• PickupCollection.cc (modified) (2 diffs)
• PickupCollectionIdentifier.cc (modified) (1 diff)
• PickupSpawner.cc (modified) (1 diff)
• items/SpeedPickup.cc (modified) (1 diff)

code/branches/doc/src/modules/pickup/DroppedPickup.cc

@@ -61 +61 @@
     @param pickup
         The Pickupable that was dropped.
-    @param position
-        The position at which the DroppedPickup should be created.
+    @param carrier
+        FIXME - add doc!
     @param triggerDistance
         The distance at which the PickupSpawner triggers. Default is 10.

code/branches/doc/src/modules/pickup/Pickup.cc

@@ -225 +225 @@
         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, const Vector3& position);
-    @param position
-        The position at which the PickupSpawner should be placed.
     @return
         Returns true if a spawner was created, false if not.

code/branches/doc/src/modules/pickup/PickupCollection.cc

@@ -228 +228 @@
     @brief
         Get whether a given class, represented by the input Identifier, is a target of this PickupCollection.
-    @param identifier
-        A pointer to the PickupIdentifier of the PickupCarrier we want to know of, whether it is a target of this PickupCollection.
+    @param carrier
+        A pointer to the PickupCarrier we want to know of, whether it is a target of this PickupCollection.
     @return
         Returns true if the PickupCarrier identified by the input PickupIdentififer it is a target of this PickupCollection, false if not.
@@ -336 +336 @@
         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, const Vector3& position);
-    @param position
-        The position at which the PickupSpawner should be placed.
     @return
         Returns true if a spawner was created, false if not.

code/branches/doc/src/modules/pickup/PickupCollectionIdentifier.cc

@@ -99 +99 @@
     @brief
         Add a Pickupable to the PickupCollectionIdentifier.
-    @param
+    @param identifier
         A pointer to the PickupIdentifier of the Pickupable to be added.
     */

code/branches/doc/src/modules/pickup/PickupSpawner.cc

@@ -70 +70 @@
     @param respawnTime
         The minimum time between two spawns.
-    @param maySpawnedItems
+    @param maxSpawnedItems
         The maximum number of items spawned by this PickupSpawner.
     */

code/branches/doc/src/modules/pickup/items/SpeedPickup.cc

@@ -252 +252 @@
     @brief
         Sets the SpeedMultiply
-    @param speedAdd
+    @param speedMultiply
         The multiplied Speed
     */