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

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

Files:

• ModularSpaceShip.cc (modified) (1 diff)
• ModularSpaceShip.h (modified) (1 diff)
• Pawn.cc (modified) (1 diff)

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.
     */