Changeset 11099 for code/trunk/src/orxonox/items/Engine.h

Timestamp:

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

Author:

muemart

Message:

Fix loads of doxygen warnings and other documentation issues

File:

• code/trunk/src/orxonox/items/Engine.h (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)