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

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/worldentities

Files:

• Actionpoint.h (modified) (3 diffs)
• WorldEntity.h (modified) (1 diff)
• pawns/ModularSpaceShip.cc (modified) (1 diff)
• pawns/ModularSpaceShip.h (modified) (1 diff)
• pawns/Pawn.cc (modified) (1 diff)

code/trunk/src/orxonox/worldentities/Actionpoint.h

@@ -49 +49 @@
         Example XML code:
 
+        @code
         <SpaceShip position="-2000, 1500, -1000" lookat="0,0,0" team=0 name="thisShipName">
           <templates>
@@ -65 +66 @@
           </controller>
         </SpaceShip>
-        
+        @endcode
+
         Example with loops:
 
+        @code
         <SpaceShip position="-1500, 1500, -1000" lookat="0,0,0" team=0 name="thisShipName">
           <templates>
@@ -83 +86 @@
           </controller>
         </SpaceShip>
+        @endcode
         
         One can also use other Worldentities instead of Actionpoints just like Waypoints, but those points

code/trunk/src/orxonox/worldentities/WorldEntity.h

@@ -400 +400 @@
             @param otherObject
                 The object this one has collided into.
+            @param ownCollisionShape
+                The collision shape of the other object
             @param contactPoint
                 Contact point provided by Bullet. Holds more information and can me modified. See return value.

code/trunk/src/orxonox/worldentities/pawns/ModularSpaceShip.cc

@@ -207 +207 @@
     @brief
         Add a ShipPart to the SpaceShip.
-    @param engine
+    @param part
         A pointer to the ShipPart to be added.
     */

code/trunk/src/orxonox/worldentities/pawns/ModularSpaceShip.h

@@ -58 +58 @@
 
         As mentioned @ref orxonox::Engine Engines can be mounted on the ModularSpaceShip.
-        In order to assign attached entities to a ShipPart, a ShipPart with the same name as the corresponding entity needs to be created in the <parts> tag.
+        In order to assign attached entities to a ShipPart, a ShipPart with the same name as the corresponding entity needs to be created in the \<parts\> tag.
         Here is a (primitive) example of a ModularSpaceShip defined in XML:
         @code

code/trunk/src/orxonox/worldentities/pawns/Pawn.cc

@@ -425 +425 @@
     /**
     @brief
-        Check whether the Pawn has a @ref Orxonox::WeaponSystem and fire it with the specified firemode if it has one.
+        Check whether the Pawn has a @ref orxonox::WeaponSystem and fire it with the specified firemode if it has one.
     */