Changeset 7297 for code/branches/doc/src/orxonox/worldentities/WorldEntity.cc

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/worldentities/WorldEntity.cc (modified) (5 diffs)

code/branches/doc/src/orxonox/worldentities/WorldEntity.cc

@@ -650 +650 @@
     @brief
         Translates this WorldEntity by a vector.
+    @param distance
+        The relative distance of the translation
     @param relativeTo
-        @see WorldEntity::TransformSpace
+        The TransformSpace of this translation
     */
     void WorldEntity::translate(const Vector3& distance, TransformSpace relativeTo)
@@ -678 +680 @@
     @brief
         Rotates this WorldEntity by a quaternion.
+    @param rotation
+        The desired relative rotation
     @param relativeTo
-        @see WorldEntity::TransformSpace
+        The TransformSpace of this translation
     */
     void WorldEntity::rotate(const Quaternion& rotation, TransformSpace relativeTo)
@@ -703 +707 @@
     @brief
         Makes this WorldEntity look at a specific target location.
+    @param target
+        An absolute point in the space which defines the direction of the entity
     @param relativeTo
-        @see WorldEntity::TransformSpace
+        The TransformSpace of this translation
     @param localDirectionVector
         The vector which normally describes the natural direction of the object, usually -Z.
@@ -729 +735 @@
     @brief
         Makes this WorldEntity look in specific direction.
+    @param direction
+        A point relative to the position of the WorldEntity which defines its orientation
     @param relativeTo
-        @see WorldEntity::TransformSpace
+        The TransformSpace of this translation
     @param localDirectionVector
         The vector which normally describes the natural direction of the object, usually -Z.
@@ -773 +781 @@
     /**
     @brief
-        Sets the CollisionType. This alters the object significantly! @see CollisionType.
+        Sets the CollisionType. This alters the object significantly!
     @note
         Operation does not work on attached WorldEntities.