Changeset 11099 for code/trunk/src/orxonox/items

Timestamp:

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

Author:

muemart

Message:

Fix loads of doxygen warnings and other documentation issues

Location:

code/trunk/src/orxonox/items

Files:

• Engine.h (modified) (2 diffs)
• PartDestructionEvent.cc (modified) (2 diffs)
• PartDestructionEvent.h (modified) (1 diff)
• ShipPart.cc (modified) (2 diffs)

code/trunk/src/orxonox/items/Engine.h

@@ -45 +45 @@
         There are many parameters that can be specified:
         - The <b>relativePosition</b>, specifies the position relative to the center of the SpaceShip the Engine is mounted on.
-        - The <b>maximal speed</b>, there are four maximal speeds that can be specified: The <b>speedfront</b>, the maximal forward speed. The <b>speedback>, the maximal backward speed. The <b>speedleftright</b>, the maximal speed in y-direction of the SpaceShip coordinate frame. The <b>speedupdown</b>, the maximal speed in z-direction of the SpaceShip coordinate frame. All maximal speeds (naturally) have to be non-negative.
+        - The <b>maximal speed</b>, there are four maximal speeds that can be specified: The <b>speedfront</b>, the maximal forward speed. The <b>speedback</b>, the maximal backward speed. The <b>speedleftright</b>, the maximal speed in y-direction of the SpaceShip coordinate frame. The <b>speedupdown</b>, the maximal speed in z-direction of the SpaceShip coordinate frame. All maximal speeds (naturally) have to be non-negative.
         - The <b>acceleration</b>, there are five types of acceleration that can be specified: The <b>accelerationfront</b>, the forward acceleration. The <b>accelerationbrake</b>, the braking acceleration. The <b>accelerationback</b>, the backward acceleration. The <b>accelerationleftright</b>, the acceleration in y-direction. The <b>accelerationupdown</b>, the acceleration in z-direction. All accelerations have to be non-negative.
         - The <b>boostfactor</b>, specifies the factor by which boosting increases the speed. This has to be non-negative, as well. Beware that maximal speeds can be overcome through boosting.
@@ -213 +213 @@
             /**
             @brief Add to the additional forward speed factor.
-            @param factor The speed that is added to the additional forward speed. Must be non-negative.
+            @param speed The speed that is added to the additional forward speed. Must be non-negative.
             */
             inline void addSpeedAdd(float speed)

code/trunk/src/orxonox/items/PartDestructionEvent.cc

@@ -164 +164 @@
     @brief
         Set type of the target
-    @param param
+    @param type
         The desired target-type as string. Valid target-types: ship engine weapon
     */
@@ -197 +197 @@
         Set the operation to be applied.
     @param param
-        The desired parameter as string. Valid parameters: c.f. @ref orxnox::PartDestructionEvent::TargetParam
+        The desired parameter as string. Valid parameters: c.f. @ref TargetParam
     */
     void PartDestructionEvent::setTargetParam(std::string param)

code/trunk/src/orxonox/items/PartDestructionEvent.h

@@ -81 +81 @@
                 @brief
                     List of all allowed parameters.
-                */
+            */
             enum class TargetParam
             {

code/trunk/src/orxonox/items/ShipPart.cc

@@ -116 +116 @@
     @brief
         Add a StaticEntity to the ShipPart.
-    @param engine
+    @param entity
         A pointer to the StaticEntity to be added.
     */
@@ -158 +158 @@
     @brief
         Add a PartDestructionEvent to the ShipPart.
-    @param engine
+    @param event
         A pointer to the PartDestructionEvent to be added.
     */