Changeset 11099 for code/trunk/src/orxonox

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

Files:

• LevelInfo.cc (modified) (2 diffs)
• LevelInfo.h (modified) (2 diffs)
• chat/ChatHistory.h (modified) (1 diff)
• chat/ChatInputHandler.h (modified) (1 diff)
• controllers/ActionpointController.h (modified) (6 diffs)
• controllers/ArtificialController.cc (modified) (1 diff)
• controllers/MasterController.h (modified) (2 diffs)
• gametypes/Dynamicmatch.cc (modified) (1 diff)
• gametypes/Dynamicmatch.h (modified) (1 diff)
• infos/GametypeInfo.cc (modified) (1 diff)
• interfaces/NotificationListener.cc (modified) (1 diff)
• interfaces/PlayerTrigger.h (modified) (1 diff)
• items/Engine.h (modified) (2 diffs)
• items/PartDestructionEvent.cc (modified) (2 diffs)
• items/PartDestructionEvent.h (modified) (1 diff)
• items/ShipPart.cc (modified) (2 diffs)
• overlays/OrxonoxOverlay.cc (modified) (1 diff)
• overlays/OverlayGroup.cc (modified) (1 diff)
• weaponsystem/WeaponSlot.h (modified) (1 diff)
• weaponsystem/WeaponSystem.cc (modified) (1 diff)
• worldentities/Actionpoint.h (modified) (3 diffs)
• worldentities/WorldEntity.h (modified) (1 diff)
• worldentities/pawns/ModularSpaceShip.cc (modified) (1 diff)
• worldentities/pawns/ModularSpaceShip.h (modified) (1 diff)
• worldentities/pawns/Pawn.cc (modified) (1 diff)

code/trunk/src/orxonox/LevelInfo.cc

@@ -115 +115 @@
     @brief
         Set the starting ship models of the level
-    @param tags
+    @param ships
         A comma-seperated string of all the allowed ship models for the shipselection.
     */
@@ -244 +244 @@
     RegisterClass(LevelInfo);
 
-    /**
-    @brief
-
-    @param creator
-        The creator of this object.
-    */
     LevelInfo::LevelInfo(Context* context) : BaseObject(context)
     {

code/trunk/src/orxonox/LevelInfo.h

@@ -197 +197 @@
     @author
         Damian 'Mozork' Frick
-    @edit
         Matthias Hutter
     @ingroup Orxonox
@@ -247 +246 @@
             /**
             @brief Set the starting ship models of the level
-            @param A comma-seperated string of all the allowed ship models for the shipselection.
+            @param ships A comma-seperated string of all the allowed ship models for the shipselection.
             */
             inline void setStartingShips(const std::string& ships)

code/trunk/src/orxonox/chat/ChatHistory.h

@@ -80 +80 @@
        *
        * \param message The incoming message
-       * \param senderID Identification number of the sender
+       * \param name Name of the sender
        */
       virtual void incomingChat(const std::string& message, const std::string& name) override;

code/trunk/src/orxonox/chat/ChatInputHandler.h

@@ -120 +120 @@
 
       /** \param message the message text
-       * \param senderID ID of the player who sent the message
+       * \param name Name of the player who sent the message
        *
        * Deal with incoming chat (which means in our case: Add it to the

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

code/trunk/src/orxonox/gametypes/Dynamicmatch.cc

@@ -26 +26 @@
  *
  */
-//TODO:
-//pig punkte vergeben pro Zeit!
-//killerfarbe schwarz; evtl. eigenes Raumfahrzeug;
-//Low; Codeoptimierung und Dokumentation
-
-/**
-@brief
-    Short Gaming Manual:
-    There are three different parties a player can belong to: victim, chaser or killer
-    Every player starts as chaser. As long as there are not enough victims and killers, you can change your and other player's parties by shooting them.
-    In order to win you have to earn as much points as possible:
-    - as victim by escaping the chasers
-    - as chaser by shooting the victim
-    - as killer by killing the chasers
-
-
-    What you shouldn't do is shooting at players of your own party. By doing so your score will decrease.
-    P.S: If you don't want to be a victim: Get rid of your part by shooting a chaser.
-*/
+
 #include "Dynamicmatch.h"
 

code/trunk/src/orxonox/gametypes/Dynamicmatch.h

@@ -42 +42 @@
 namespace orxonox
 {
+    /**
+    @brief
+        Short Gaming Manual:
+        There are three different parties a player can belong to: victim, chaser or killer
+        Every player starts as chaser. As long as there are not enough victims and killers, you can change your and other player's parties by shooting them.
+        In order to win you have to earn as much points as possible:
+        - as victim by escaping the chasers
+        - as chaser by shooting the victim
+        - as killer by killing the chasers
+
+
+        What you shouldn't do is shooting at players of your own party. By doing so your score will decrease.
+        P.S: If you don't want to be a victim: Get rid of your part by shooting a chaser.
+
+        @todo:
+        pig punkte vergeben pro Zeit!
+        killerfarbe schwarz; evtl. eigenes Raumfahrzeug;
+        Low; Codeoptimierung und Dokumentation
+    */
     class _OrxonoxExport Dynamicmatch : public Gametype
     {

code/trunk/src/orxonox/infos/GametypeInfo.cc

@@ -378 +378 @@
     @param player
         The player that has changed its spawned status.
-    @param ready
+    @param spawned
         The new spawned status.
     */

code/trunk/src/orxonox/interfaces/NotificationListener.cc

@@ -102 +102 @@
     @param isCommand
         Whether the message is a command or a notification.
-    @param messageType
+    @param type
         The type of the notification.
     */

code/trunk/src/orxonox/interfaces/PlayerTrigger.h

@@ -82 +82 @@
         /**
         @brief Set the player that triggered the PlayerTrigger. This is normally done by classes inheriting vom PlayerTrigger.
-        @param player A pointer to the Pawn that triggered the PlayerTrigger.
+        @param pawn A pointer to the Pawn that triggered the PlayerTrigger.
         */
         void setTriggeringPawn(Pawn* pawn);

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

code/trunk/src/orxonox/overlays/OrxonoxOverlay.cc

@@ -126 +126 @@
         This has to be called before usage, otherwise strange behaviour is
         guaranteed! (there should be no segfaults however).
-    @copydoc
-        BaseObject::XMLPort()
+    @copydoc BaseObject::XMLPort()
     */
     void OrxonoxOverlay::XMLPort(Element& xmlelement, XMLPort::Mode mode)

code/trunk/src/orxonox/overlays/OverlayGroup.cc

@@ -85 +85 @@
     @brief
         Loads the group and all its children OrxonoxOverlays.
-    @copydoc
-        BaseObject::XMLPort()
+    @copydoc BaseObject::XMLPort()
     */
     void OverlayGroup::XMLPort(Element& xmlelement, XMLPort::Mode mode)

code/trunk/src/orxonox/weaponsystem/WeaponSlot.h

@@ -48 +48 @@
           <WeaponSlot position="    0,   0,0" />
         </weaponslots>
+        @endcode
 
         A WeaponSlot can be attached to a @ref orxonox::Pawn because WeaponSlot inherits from @ref orxonox::StaticEntity.

code/trunk/src/orxonox/weaponsystem/WeaponSystem.cc

@@ -285 +285 @@
     /**
     @brief
-        Fires the @ref Orxonox::WeaponSet with the specified firemode.
+        Fires the @ref orxonox::WeaponSet with the specified firemode.
     */
     void WeaponSystem::fire(unsigned int firemode)

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