Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

Ignore:
Timestamp:
Jan 27, 2016, 6:50:51 PM (8 years ago)
Author:
muemart
Message:

Fix loads of doxygen warnings and other documentation issues

Location:
code/trunk/src/modules
Files:
40 edited

Legend:

Unmodified
Added
Removed

  • code/trunk/src/modules/docking/DockingAnimation.h

    r9667 r11099  
    5353    /**
    5454    @brief
    55         Base class for docking animations used by @ref orxonox::Docking "Docks".
     55        Base class for docking animations used by @ref orxonox::Dock "Docks".
    5656
    5757    @author

  • code/trunk/src/modules/docking/DockingEffect.h

    r9667 r11099  
    5151    /**
    5252    @brief
    53         Handles DockingEffects for @ref orxonox::Docking "Docks".
     53        Handles DockingEffects for @ref orxonox::Dock "Docks".
    5454
    5555    @author

  • code/trunk/src/modules/docking/DockingTarget.h

    r11071 r11099  
    4545    /**
    4646    @brief
    47         DockingTargets for @ref orxonox::Docking "Docks".
     47        DockingTargets for @ref orxonox::Dock "Docks".
    4848
    4949    @author

  • code/trunk/src/modules/docking/MoveToDockingTarget.h

    r11071 r11099  
    4646    /**
    4747    @brief
    48         Base class for docking animations used by @ref orxonox::Docking "Docks".
     48        Base class for docking animations used by @ref orxonox::Dock "Docks".
    4949
    5050    @author

  • code/trunk/src/modules/gametypes/SpaceRaceController.cc

    r11083 r11099  
    2424 */
    2525
    26 /**
    27  * Conventions:
    28  * -first Checkpoint has index 0
    29  * -staticCheckPoint= static Point (see def over = constructor)
    30  */
    31 
    32 /*TODO:
    33  * tICK KORRIGIEREN
    34  *
    35  *
    36  */
    3726#include <gametypes/SpaceRaceController.h>
    3827#include "core/CoreIncludes.h"

  • code/trunk/src/modules/gametypes/SpaceRaceController.h

    r11071 r11099  
    3636namespace orxonox
    3737{
     38    /**
     39     * Conventions:
     40     * -first Checkpoint has index 0
     41     * -staticCheckPoint= static Point (see def over = constructor)
     42     *@todo:
     43     *  tICK KORRIGIEREN
     44     */
    3845    class _GametypesExport SpaceRaceController: public ArtificialController,
    3946            public Tickable

  • code/trunk/src/modules/hover/HoverFlag.cc

    r11071 r11099  
    8080    @param yCoordinate
    8181        Y-Coordinate of the flage, 0-9, origin is bottom left
     82    @param cellSize
     83        The size of the cells
    8284    */
    8385    void HoverFlag::init(int xCoordinate, int yCoordinate, int cellSize)

  • code/trunk/src/modules/hover/HoverOrigin.h

    r11071 r11099  
    4141        The HoverOrigin implements the playing field @ref orxonox::Hover "Hover" takes place in and allows for many parameters of the minigame to be set.
    4242        The playing field resides in the x,z-plane, with the x-axis being the horizontal axis and the z-axis being the vertical axis.
    43        
    44         Various parameters can be set:
    45         - The <b>dimension</b> is a vector, that defines the width and height of the playing field. The default is <em>(200, 120)</em>.
    46         - The <b>balltemplate</b> is a template that is applied to the @ref orxonox::HoverPlatform "HoverPlatform", it can be used to attach different things to it, e.g. its @ref orxonox::Model "Model". See below for a usage example.
    47         - The <b>battemplate</b> is a template that is applied to the @ref orxonox::HoverPlatform "HoverFigure", it can be used to attach different things to it, e.g. its @ref orxonox::Model "Model". See below for a usage example.
    48         - The <b>ballspeed</b> is the speed with which the @ref orxonox::HoverPlatform "HoverPlatform" moves. The default is <em>100</em>.
    49         - The <b>ballaccfactor</b> is the acceleration factor for the @ref orxonox::HoverPlatform "HoverPlatform". The default is <em>1.0</em>.
    50         - The <b>batspeed</b> is the speed with which the @ref orxonox::HoverFigure "HoverFigures" move. The default is <em>60</em>.
    51         - The <b>batlength</b> is the length of the @ref orxonox::HoverFigure "HoverFigures" as the percentage of the height of the playing field. The default is <em>0.25</em>.
    52        
    53         An example in XML of the HoverOrigin would be:
    54        
    55         First the needed templates:
    56         The template for the @ref orxonox::HoverPlatform "HoverPlatform".
    57         @code
    58         <Template name="Hoverball">
    59           <HoverPlatform>
    60             <attached>
    61               <Model mesh="sphere.mesh" scale="2" />
    62               <ParticleSpawner name="hiteffect" position="0,0,0" source="Orxonox/sparks2" lifetime="0.01" autostart="0" mainstate="spawn" />
    63             </attached>
    64             <eventlisteners>
    65               <EventTarget target="hiteffect" />
    66             </eventlisteners>
    67           </HoverPlatform>
    68         </Template>
    69         @endcode
    70         As can be seen, a sphere is attached as the @ref orxonox::Model "Model" for the @ref orxonox::HoverPlatform "HoverPlatform", and also an @ref orxonox::EventListener "EventListener" that triggers a @ref orxonox::ParticleSpawner "ParticleSpawner", whenever the ball hits the boundaries is attached.
    71        
    72         Additionally the template for the @ref orxonox::HoverFigure "HoverFigure".
    73         @code
    74         <Template name="Hoverbatcameras" defaults="0">
    75           <HoverFigure>
    76             <camerapositions>
    77               <CameraPosition position="0,200,0" pitch="-90" absolute="true" />
    78             </camerapositions>
    79           </HoverFigure>
    80         </Template>
    81 
    82         <Template name="Hoverbat">
    83           <HoverFigure camerapositiontemplate=Hoverbatcameras>
    84             <attached>
    85               <Model position="0,0,3" mesh="cube.mesh" scale3D="14,2,2" />
    86             </attached>
    87           </HoverFigure>
    88         </Template>
    89         @endcode
    90         As can be seen, there are actually two templates. The first template is needed to set the camera for the @ref orxonox::HoverFigure "HoverFigure". The second template ist the actual template for the @ref orxonox::HoverFigure "HoverFigure", the template for the camera position is added and a @ref orxonox::Model "Model" for the @ref orxonox::HoverFigure "HoverFigure" is attached.
    91         propellerTemplate_
    92         Finally the HoverOrigin is created.
    93         @code
    94         <HoverOrigin name="Hovercenter" dimension="200,120" balltemplate="Hoverball" battemplate="Hoverbat" ballspeed="200" ballaccfactor="1.0" batspeed="130" batlength="0.25">
    95           <attached>
    96             <Model position="0,0,60" mesh="cube.mesh" scale3D="105,1,1" />
    97             <Model position="0,0,-60" mesh="cube.mesh" scale3D="105,1,1" />
    98           </attached>
    99         </HoverOrigin>
    100         @endcode
    101         All parameters are specified. And also two @ref orxonox::Model "Models" (for the upper and lower boundary) are attached.
    102        
    103         For a more elaborate example, have a look at the <code>Hover.oxw</code> level file.
     43        For an example, have a look at the <code>Hover.oxw</code> level file.
    10444
    10545    */

  • code/trunk/src/modules/hover/HoverWall.cc

    r11071 r11099  
    7676    @param y
    7777        y-Coordinate of the Square that the Wall is attached to, 0-9, Origin is Bottom left
     78    @param cellSize
     79        The size of a cell
     80    @param cellHeight
     81        The height of a cell
    7882    @param orientation
    7983            Wall on the right side (1) or on top (2) of this square, 0-1       

  • code/trunk/src/modules/jump/JumpEnemy.cc

    r11071 r11099  
    139139    }
    140140
    141     /**
    142     @brief
    143         Set the bats for the ball.
    144     @param bats
    145         An array (of size 2) of weak pointers, to be set as the new bats.
    146     */
    147141    void JumpEnemy::setFigure(JumpFigure* newFigure)
    148142    {

  • code/trunk/src/modules/mini4dgame/Mini4DgameBoard.cc

    r11071 r11099  
    7272
    7373    /**
    74         @brief checks if the move is valid
    75         @param the position where to put the stone plus the player who makes the move
     74        @brief Checks if the move is valid
     75        @param move The position where to put the stone
    7676    */
    7777    bool Mini4DgameBoard::isValidMove(const Mini4DgamePosition& move)
    … …  
    9898    /**
    9999    @brief makes a move on the logic playboard
    100     @param the position where to put the stone plus the player who makes the move
     100    @param move The position where to put the stone
    101101    */
    102102    void Mini4DgameBoard::makeMove(const Mini4DgamePosition& move)

  • code/trunk/src/modules/notifications/NotificationDispatcher.h

    r11071 r11099  
    103103            /**
    104104            @brief Set the NotificationDispatcher to broadcast.
    105             @param broadcast Whether the NotificationDispatcher is set to broadcast or singlecast.
     105            @param v Whether the NotificationDispatcher is set to broadcast or singlecast.
    106106            */
    107107            void setBroadcasting(bool v)

  • code/trunk/src/modules/notifications/NotificationQueue.cc

    r11071 r11099  
    4949    @brief
    5050        Default constructor. Registers and initializes the object.
    51     @param creator
    52         The creator of the NotificationQueue.
    5351    */
    5452    NotificationQueue::NotificationQueue(Context* context) : BaseObject(context), Synchronisable(context), registered_(false)
    … …  
    6563        this->registerVariables();
    6664    }
    67 
    68     // TODO move to docu.
    69     /**
    70     @brief
    71         Constructor. Registers and initializes the object.
    72     @param creator
    73         The creator of the NotificationQueue
    74     @param name
    75         The name of the new NotificationQueue. It needs to be unique
    76     @param senders
    77         The senders that are targets of this NotificationQueue, i.e. the names of senders whose Notifications this NotificationQueue displays.
    78         The senders need to be seperated by commas.
    79     @param size
    80         The size (the maximum number of displayed Notifications) of this NotificationQueue.
    81     @param displayTime
    82         The time during which a Notification is (at most) displayed.
    83     */
    8465
    8566    /**

  • code/trunk/src/modules/objects/Script.cc

    r11071 r11099  
    5858    @brief
    5959        Constructor. Registers and initializes the object.
    60     @param creator
    61         The creator of this object.
    6260    */
    6361    Script::Script(Context* context) : BaseObject(context)

  • code/trunk/src/modules/objects/Turret.h

    r11071 r11099  
    2828
    2929/**
     30    @file Turret.h
    3031    @brief Definition of the Turret class.
    3132    @ingroup Objects

  • code/trunk/src/modules/objects/controllers/TurretController.h

    r10262 r11099  
    2626 *
    2727 */
    28 
    29 /**
    30     @brief Definition for the controller for turrets.
    31 */
    3228
    3329#ifndef _TurretController_H__

  • code/trunk/src/modules/objects/triggers/DistanceTrigger.cc

    r11071 r11099  
    5454    @brief
    5555        Constructor. Registers and initializes the object.
    56     @param creator
    57         The creator of this trigger.
    5856    */
    5957    DistanceTrigger::DistanceTrigger(Context* context) : Trigger(context)

  • code/trunk/src/modules/objects/triggers/DistanceTriggerBeacon.cc

    r9667 r11099  
    4545    @brief
    4646        Constructor. Registers the object.
    47     @param creator
    48         The creator of this object.
    4947    */
    5048    DistanceTriggerBeacon::DistanceTriggerBeacon(Context* context) : StaticEntity(context)

  • code/trunk/src/modules/objects/triggers/EventTrigger.cc

    r11071 r11099  
    4545    @brief
    4646        Constructor. Registers and initializes the object.
    47     @param creator
    48         The creator of the EventTrigger.
    4947    */
    5048    EventTrigger::EventTrigger(Context* context) : Trigger(context)

  • code/trunk/src/modules/objects/triggers/MultiTrigger.cc

    r11071 r11099  
    4848    @brief
    4949        Constructor. Registers the objects and initializes default values.
    50     @param creator
    51         The creator.
    5250    */
    5351    MultiTrigger::MultiTrigger(Context* context) : TriggerBase(context)

  • code/trunk/src/modules/objects/triggers/MultiTriggerContainer.cc

    r11071 r11099  
    4747    @brief
    4848        Default constructor. Registers the object and creates an empty container.
    49     @param creator
    50         The creator.
    5149    */
    5250    MultiTriggerContainer::MultiTriggerContainer(Context* context) : BaseObject(context), originator_(nullptr), data_(nullptr)
    … …  
    5856    @brief
    5957        Constructor. Registers the object and sets the input values.
    60     @param creator
    61         The creator.
     58    @param context
     59        The context.
    6260    @param originator
    6361        A pointer to the originator of the Event, i.e. the MultiTrigger that fired the Event. (or is about to fire)

  • code/trunk/src/modules/objects/triggers/Trigger.cc

    r11071 r11099  
    5151    @brief
    5252        Constructor. Registers and initializes the object.
    53     @param creator
    54         The creator of the Trigger.
    5553    */
    5654    Trigger::Trigger(Context* context) : TriggerBase(context)

  • code/trunk/src/modules/pickup/Pickup.cc

    r11071 r11099  
    5353    @brief
    5454        Constructor. Registers and initializes the object.
    55     @param creator
    56         The objects creator.
    5755    */
    5856    Pickup::Pickup(Context* context) : BaseObject(context)

  • code/trunk/src/modules/pickup/PickupCollection.cc

    r11071 r11099  
    5050    @brief
    5151        Default Constructor.
    52     @param creator
    53         The creator of the object.
    5452    */
    5553    PickupCollection::PickupCollection(Context* context) : BaseObject(context)

  • code/trunk/src/modules/pickup/PickupManager.cc

    r11071 r11099  
    335335    @param representationObjectId
    336336        The objectId identifying (over the network) the PickupRepresentation that represents this Pickupable.
     337    @param representationName
     338        The name of the associated PickupRepresentation
    337339    @param pickedUp
    338340        The pickedUp status the Pickupable changed to.

  • code/trunk/src/modules/pickup/PickupSpawner.cc

    r11071 r11099  
    5252    @brief
    5353        Constructor. Creates a blank PickupSpawner.
    54     @param creator
    55         Pointer to the object which created this item.
    5654    */
    5755    PickupSpawner::PickupSpawner(Context* context) : StaticEntity(context), pickup_(nullptr), representation_(nullptr), pickupTemplate_(nullptr)
    … …  
    9088    @brief
    9189        Factory method, Creates a fully functional PickupSpawner.
    92     @param creator
    93         The creator of this PickupSpawner.
     90    @param context
     91        The context of this PickupSpawner.
    9492    @param pickup
    9593        The Pickupable to be spawned by this PickupSpawner.

  • code/trunk/src/modules/pickup/items/DamageBoostPickup.h

    r9667 r11099  
    6868
    6969            /**
    70              @brief set Damage multiplier
    71              @param multiplier The default damage multiplier to set
     70             @brief Get Damage multiplier
    7271             */
    7372            inline float getDamageMultiplier()

  • code/trunk/src/modules/tetris/TetrisCenterpoint.h

    r11071 r11099  
    105105            /**
    106106            @brief Set the template for the stones.
    107             @param template The template name to be applied to each stone.
     107            @param templateName The template name to be applied to each stone.
    108108            */
    109109            void setStoneTemplate(const std::string& templateName)
    … …  
    118118            /**
    119119            @brief Set the template for the bricks.
    120             @param template The template name to be applied to each brick.
     120            @param templateName The template name to be applied to each brick.
    121121            */
    122122            void setBrickTemplate(const std::string& templateName)

  • code/trunk/src/modules/towerdefense/TowerDefense.h

    r11071 r11099  
    2727 */
    2828
    29  /**
    30     @brief
    31         GameType class for TowerDefense. See TowerDefenseReadme.txt for Information.
    32 
    33     @ingroup TowerDefense
    34  */
    35 
    3629
    3730#ifndef _TowerDefense_H__
    … …  
    4740namespace orxonox
    4841{
     42    /**
     43    @brief
     44    GameType class for TowerDefense. See TowerDefenseReadme.txt for Information.
     45
     46    @ingroup TowerDefense
     47    */
    4948    class _TowerDefenseExport TowerDefense : public TeamDeathmatch
    5049    {

  • code/trunk/src/modules/towerdefense/TowerDefenseCenterpoint.h

    r11071 r11099  
    2727 */
    2828
    29 /**
    30  @brief
    31  See TowerDefenseReadme.txt for Information.
    32  @ingroup TowerDefense
    33  */
    34 
    3529
    3630#ifndef _TowerDefenseCenterpoint_H__
    … …  
    4640namespace orxonox
    4741{
     42    /**
     43    @brief
     44    See TowerDefenseReadme.txt for Information.
     45    @ingroup TowerDefense
     46    */
    4847    class _TowerDefenseExport TowerDefenseCenterpoint : public MobileEntity
    4948    {

  • code/trunk/src/modules/towerdefense/TowerDefenseEnemy.cc

    r11071 r11099  
    55//  Created by Jonas Erb on 22.10.14.
    66
    7 /**
    8 @brief
    9 See TowerDefenseReadme.txt for Information.
    10 
    11 @ingroup TowerDefense
    12 */
    137#include "TowerDefenseEnemy.h"
    148#include "core/CoreIncludes.h"

  • code/trunk/src/modules/towerdefense/TowerDefenseEnemy.h

    r11071 r11099  
    55//  Created by Jonas Erb on 22.10.14.
    66
    7 /**
    8 @brief
    9 See TowerDefenseReadme.txt for Information.
    107
    11 @ingroup TowerDefense
    12 */
    138
    149
    … …  
    2621namespace orxonox
    2722{
    28 /* Class to give the TowerDefenseEnemy spaceships waypoints and
    29  *
    30  */
     23    /**
     24    @brief
     25    See TowerDefenseReadme.txt for Information.
     26
     27    @ingroup TowerDefense
     28    */
    3129    class _TowerDefenseExport TowerDefenseEnemy : public SpaceShip
    3230    {

  • code/trunk/src/modules/towerdefense/TowerDefenseField.h

    r11071 r11099  
    2727 */
    2828
    29 /**
    30  @brief
    31  See TowerDefenseReadme.txt for Information.
    32  @ingroup TowerDefense
    33  */
    3429
    3530
    … …  
    5651    };
    5752
    58 
     53    /**
     54    @brief
     55    See TowerDefenseReadme.txt for Information.
     56    @ingroup TowerDefense
     57    */
    5958    class _TowerDefenseExport TowerDefenseField : public MovableEntity
    6059    {

  • code/trunk/src/modules/towerdefense/TowerDefenseHUDController.h

    r11071 r11099  
    2727 */
    2828
    29  /**
    30     @brief
    31         This subclass of OverlayText is used to display the stats of the player in the HUD
    32 
    33     @ingroup TowerDefense
    34  */
    35 
    3629
    3730#ifndef _TowerDefenseHUDController_H__
    … …  
    4639namespace orxonox
    4740{
     41    /**
     42    @brief
     43    This subclass of OverlayText is used to display the stats of the player in the HUD
     44
     45    @ingroup TowerDefense
     46    */
    4847    class _TowerDefenseExport TowerDefenseHUDController : public OverlayText, public Tickable
    4948    {

  • code/trunk/src/modules/towerdefense/TowerDefenseTower.h

    r10629 r11099  
    66//  Copyright (c) 2012 __MyCompanyName__. All rights reserved.
    77//
    8 
    9 /**
    10 @brief
    11 See TowerDefenseTowerDefenseReadme.txt for Information.
    12 
    13 @ingroup TowerDefenseTowerDefense
    14 */
    158
    169
    … …  
    2417namespace orxonox
    2518{
     19    /**
     20    @brief
     21    See TowerDefenseTowerDefenseReadme.txt for Information.
     22
     23    @ingroup TowerDefenseTowerDefense
     24    */
    2625    class _TowerDefenseExport TowerDefenseTower : public Turret
    2726    {

  • code/trunk/src/modules/weapons/projectiles/BasicProjectile.cc

    r11071 r11099  
    7474    @param contactPoint
    7575        A btManifoldPoint indicating the point of contact/impact.
     76    @param cs
     77        The btCollisionShape of the other object
    7678    @return
    7779        Returns true if the collision resulted in a successful hit.

  • code/trunk/src/modules/weapons/projectiles/BasicProjectile.h

    r10293 r11099  
    9797            /**
    9898            @brief Get the shield-damage done by this projectile.
    99                    Shield-damage only reduces shield health.
    100             @param shielddamage The amount of damage. Is non-negative.
    10199            */
    102100            inline float getShieldDamage() const

  • code/trunk/src/modules/weapons/projectiles/GravityBombField.h

    r11071 r11099  
    5050     * @date    23.05.2015
    5151     *
    52      * @param [in,out] the Pawn that created the field.
     52     * @param [in,out] shooter the Pawn that created the field.
    5353     */
    5454    void setShooter(Pawn* shooter)

  • code/trunk/src/modules/weapons/projectiles/SplitGunProjectile.cc

    r11052 r11099  
    8080    /**
    8181    @brief
    82         This function starts a timer that will cause the projectile to split after a time defined by the argument @param splitTime.       
     82        This function starts a timer that will cause the projectile to split after a time defined by the argument @p splitTime.
     83    @param splitTime The time
    8384    */
    8485    void SplitGunProjectile::setSplitTime(float splitTime)

  • code/trunk/src/modules/weapons/weaponmodes/HsW01.h

    r11071 r11099  
    7676            /**
    7777            @brief Set the sound.
    78             @param mesh The Sound name.
     78            @param sound The Sound name.
    7979            */
    8080            void setSound(const std::string& sound)
Note: See TracChangeset for help on using the changeset viewer.