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

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

Files:

• ActionpointController.h (modified) (6 diffs)
• ArtificialController.cc (modified) (1 diff)
• MasterController.h (modified) (2 diffs)

code/trunk/src/orxonox/controllers/ActionpointController.h

@@ -94 +94 @@
             @brief
                 XML method, example XML usage:
+
+                @code
                 <SpaceShip position="-2000, 1500, -1000" lookat="0,0,0" team=0 name="ss2">
                   <templates>
@@ -110 +112 @@
                   </controller>
                 </SpaceShip>
+                @endcode
                 
                 Full description:
@@ -116 +119 @@
                 If any WorldEntity that is not Actionpoint or its child being sent to actionpoints through XML,
                 action would be assumed to be Action::FLY and target position to be position of the entity. Also, if not Actionpoint
-                is passed, it is assumed to be in a loop. How it works is: in <actionpoints> first all Actionpoints between 
+                is passed, it is assumed to be in a loop. How it works is: in \<actionpoints\> first all Actionpoints between 
                 first Actionpoint with loopStart=true and first following Actionpoint with loopEnd=true are included in a single loop.
                 If they are adjacent (in the input array) with WorldEntity, then WorldEntity is also in a loop.
@@ -122 +125 @@
                
                 Loop example:
+
+                @code
                 <SpaceShip position="-1500, 1500, -1000" lookat="0,0,0" team=0 name="ss1">
                   <templates>
@@ -137 +142 @@
                   </controller>
                 </SpaceShip>
+                @endcode
                
                 other loop example:
+
+                @code
                 <SpaceShip position="-1500, -1500, -1500" lookat="0,0,0" team=0 name="ss1">
                   <templates>
@@ -153 +161 @@
                     </DivisionController>
                   </controller>
-                </SpaceShip> 
+                </SpaceShip>
+                @endcode
 
             @note
-                Don't use several loops, and don't use WorldEntities as input to <actionpoints> as I didn't test it well, but you
+                Don't use several loops, and don't use WorldEntities as input to \<actionpoints\> as I didn't test it well, but you
                 can try if feeling lucky.  
             */

code/trunk/src/orxonox/controllers/ArtificialController.cc

@@ -255 +255 @@
         @brief Adds first waypoint of type name to the waypoint stack, which is within the searchDistance
         @param name object-name of a point of interest (e.g. "PickupSpawner", "ForceField")
+        @param searchDistance The maximum distance to search
     */
     void ArtificialController::updatePointsOfInterest(std::string name, float searchDistance)

code/trunk/src/orxonox/controllers/MasterController.h

@@ -44 +44 @@
       If no MasterController is initialized, none of ActionpointControllers will work.
       Example:
+
+      @code
       <Pawn position = "100000, 100000, 100000">
         <controller>
@@ -50 +52 @@
         </controller>
       </Pawn>
+      @endcode
     */
     class _OrxonoxExport MasterController : public Controller, public Tickable