Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

Changeset 4836 in orxonox.OLD


Ignore:
Timestamp:
Jul 12, 2005, 12:33:16 AM (19 years ago)
Author:
bensch
Message:

orxonox/trunk: renamed all the \param → @param and so on in Doxygen tags.
Thanks a lot to the kDevelop team. this took since the last commit :)

Location:
orxonox/trunk/src
Files:
180 edited

Legend:

Unmodified
Added
Removed

  • orxonox/trunk/src/collision.h

    r3474 r4836  
    11/*!
    22    \file collision.h
    3     \brief Basic collision detection
     3  * Basic collision detection
    44*/
    55

  • orxonox/trunk/src/defs/class_id.h

    r4807 r4836  
    1818/*!
    1919    \file class_id.h
    20     \brief list of orxonox classID's
     20  * list of orxonox classID's
    2121
    2222    this File is used to identify an Object with its class and also with its sub/super-classes.
    … …  
    4545 * The last three entries are for any classes in existence eg. SkyBox and so on
    4646 *
    47  * \todo complete this List
     47 * @todo complete this List
    4848*/
    4949typedef enum ClassID
    … …  
    149149  CL_FONT                 =    0x00000802,
    150150  CL_MATERIAL             =    0x00000803,
    151   CL_MODEL                =    0x00000804, //!< \todo make this a SUBCLASS maybe
     151  CL_MODEL                =    0x00000804, //!< @todo make this a SUBCLASS maybe
    152152  CL_OBJMODEL             =    0x00000805,
    153153  CL_PROMITIVE_MODEL      =    0x00000806,

  • orxonox/trunk/src/defs/debug.h

    r4808 r4836  
    1616/*!
    1717    \file debug.h
    18     \brief Handles output to console for different Verbose-Modes.
     18  * Handles output to console for different Verbose-Modes.
    1919
    2020    There are two main modes HARD and SOFT. HARD is precessed during compileTime where SOFT is for runtime.

  • orxonox/trunk/src/defs/error.h

    r3475 r4836  
    1919/*!
    2020    \file error.h
    21     \brief A compendium of Error codes used in the program
     21  * A compendium of Error codes used in the program
    2222*/
    2323
    … …  
    3232
    3333/*!
    34     \brief Error Definitions:
     34  * Error Definitions:
    3535
    3636    Error Classes:

  • orxonox/trunk/src/glmenu/glmenu_imagescreen.cc

    r4834 r4836  
    2828using namespace std;
    2929/**
    30    \param root The Element to load the GLMenu from
    31 */
     30 * @param root The Element to load the GLMenu from
     31 */
    3232GLMenuImageScreen::GLMenuImageScreen(const TiXmlElement* root)
    3333{
    … …  
    4949
    5050/**
    51    \brief Loads a GLMenu from an inputElement
    52    \param root The Element to load the GLMenu from
     51 * Loads a GLMenu from an inputElement
     52 * @param root The Element to load the GLMenu from
    5353*/
    5454void GLMenuImageScreen::loadParams(const TiXmlElement* root)
    … …  
    7171
    7272/**
    73    \brief standard deconstructor
    74    \todo this deconstructor is not jet implemented - do it
     73 * standard deconstructor
     74   @todo this deconstructor is not jet implemented - do it
    7575*/
    7676GLMenuImageScreen::~GLMenuImageScreen()
    … …  
    8181
    8282/**
    83     \brief sets the background image name
    84     \param backImageName name of the backgroun-image
     83  * sets the background image name
     84  * @param backImageName name of the backgroun-image
    8585 */
    8686void GLMenuImageScreen::setBackgroundImage (const char* backImageName)
    … …  
    9090
    9191/**
    92    \brief sets position of the ImageScreen
    93    \param offsetX offset from the top left corner in percent(0-1) of the screensize
    94    \param offsetY offset from the top left corner in percent(0-1) of the screensize
     92 * sets position of the ImageScreen
     93 * @param offsetX offset from the top left corner in percent(0-1) of the screensize
     94 * @param offsetY offset from the top left corner in percent(0-1) of the screensize
    9595*/
    9696void GLMenuImageScreen::setPosition(float offsetX, float offsetY)
    … …  
    102102/**
    103103  \brief sets size of the ImageScreen
    104   \param scaleX the scaleing of the image into the x-direction (in percent (0-1))
    105   \param scaleY the scaleing of the image into the y-direction (in percent (0-1))
     104 * @param scaleX the scaleing of the image into the x-direction (in percent (0-1))
     105 * @param scaleY the scaleing of the image into the y-direction (in percent (0-1))
    106106*/
    107107void GLMenuImageScreen::setScale(float scaleX, float scaleY)
    … …  
    113113/**
    114114  \brief sets position and size of the ImageScreen
    115   \param offsetX offset from the top left corner in percent(0-1) of the screensize
    116   \param offsetY offset from the top left corner in percent(0-1) of the screensize
    117   \param scaleX the scaleing of the image into the x-direction (in percent (0-1))
    118   \param scaleY the scaleing of the image into the y-direction (in percent (0-1))
     115* @param offsetX offset from the top left corner in percent(0-1) of the screensize
     116* @param offsetY offset from the top left corner in percent(0-1) of the screensize
     117* @param scaleX the scaleing of the image into the x-direction (in percent (0-1))
     118* @param scaleY the scaleing of the image into the y-direction (in percent (0-1))
    119119*/
    120120void GLMenuImageScreen::setPosScale(float offsetX, float offsetY, float scaleX, float scaleY)
    … …  
    125125
    126126/**
    127    \param barImage An image for the Bar
     127 * @param barImage An image for the Bar
    128128*/
    129129void GLMenuImageScreen::setBarImage(const char* barImage)
    … …  
    133133
    134134/**
    135    \brief sets the Position and the Size of the bar
    136    \param barX The Position in the x-direction in percent of the screen (0-1)
    137    \param barY The Position in the y-direction in percent of the screen (0-1)
    138    \param barW The Size in the x-direction in percent of the screen (0-1)
    139    \param barH The Size in the y-direction in percent of the screen (0-1)
     135 * sets the Position and the Size of the bar
     136 * @param barX The Position in the x-direction in percent of the screen (0-1)
     137 * @param barY The Position in the y-direction in percent of the screen (0-1)
     138 * @param barW The Size in the x-direction in percent of the screen (0-1)
     139 * @param barH The Size in the y-direction in percent of the screen (0-1)
    140140*/
    141141void GLMenuImageScreen::setBarPosScale(float barX, float barY, float barW, float barH)
    … …  
    149149
    150150/**
    151    \brief set the maximum of countable steps
    152    \param maxValue of steps
     151 * set the maximum of countable steps
     152 * @param maxValue of steps
    153153*/
    154154void GLMenuImageScreen::setMaximum(int maxValue)
    … …  
    158158
    159159/**
    160    \brief set current value
    161    \param currentValue value to set
     160 * set current value
     161 * @param currentValue value to set
    162162*/
    163163void GLMenuImageScreen::setValue(int currentValue)
    … …  
    169169
    170170/**
    171    \brief get the current value
     171 * get the current value
    172172 */
    173173int GLMenuImageScreen::getValue()
    … …  
    178178
    179179/**
    180     \brief call this to trigger a progress event
     180  * call this to trigger a progress event
    181181
    182182    this has to redraw the progress bar and the whole image
    … …  
    196196
    197197/**
    198    \brief draws the ImageScreen to the screenbuffer
     198 * draws the ImageScreen to the screenbuffer
    199199*/
    200200void GLMenuImageScreen::draw ()

  • orxonox/trunk/src/glmenu/glmenu_imagescreen.h

    r4746 r4836  
    11/*!
    22    \file glmenu_imagescreen.h
    3     \brief class to display a LoadScreen
     3  * class to display a LoadScreen
    44*/
    55
    … …  
    3131
    3232  void setMaximum (int maxValue);
    33   /** \returns the maximum of countable steps*/
     33  /** @returns the maximum of countable steps*/
    3434  inline int GLMenuImageScreen::getMaximum() const { return this->maxValue; };
    3535

  • orxonox/trunk/src/lib/collision_detection/bounding_sphere.cc

    r4513 r4836  
    2222
    2323/**
    24    \brief standard constructor
     24 * standard constructor
    2525*/
    2626BoundingSphere::BoundingSphere ()
    … …  
    3131
    3232/**
    33    \brief standard deconstructor
     33 * standard deconstructor
    3434
    3535*/

  • orxonox/trunk/src/lib/collision_detection/bounding_sphere.h

    r4525 r4836  
    11/*!
    22    \file bounding_sphere.h
    3     \brief Definition of a bounding sphere
     3  * Definition of a bounding sphere
    44
    55*/

  • orxonox/trunk/src/lib/collision_detection/bounding_volume.cc

    r4814 r4836  
    2323
    2424/**
    25    \brief standard constructor
     25 * standard constructor
    2626*/
    2727BoundingVolume::BoundingVolume ()
    … …  
    3434
    3535/**
    36    \brief standard deconstructor
     36 * standard deconstructor
    3737
    3838*/

  • orxonox/trunk/src/lib/collision_detection/bounding_volume.h

    r4814 r4836  
    11/*!
    22    \file bounding_volume.h
    3     \brief Definition of a bounding volume for collision detection algorithms
     3  * Definition of a bounding volume for collision detection algorithms
    44
    55 */

  • orxonox/trunk/src/lib/collision_detection/bv_tree.cc

    r4528 r4836  
    2222
    2323/**
    24    \brief standard constructor
     24 * standard constructor
    2525*/
    2626BVTree::BVTree ()
    … …  
    3232
    3333/**
    34    \brief standard deconstructor
     34 * standard deconstructor
    3535
    3636*/

  • orxonox/trunk/src/lib/collision_detection/bv_tree.h

    r4712 r4836  
    11/*!
    22    \file bv_tree.h
    3     \brief Definition of a bounding volume tree
     3  * Definition of a bounding volume tree
    44
    55*/

  • orxonox/trunk/src/lib/collision_detection/bv_tree_node.cc

    r4814 r4836  
    2222
    2323/**
    24    \brief standard constructor
     24 * standard constructor
    2525*/
    2626BVTreeNode::BVTreeNode ()
    … …  
    3232
    3333/**
    34    \brief standard deconstructor
     34 * standard deconstructor
    3535
    3636*/

  • orxonox/trunk/src/lib/collision_detection/bv_tree_node.h

    r4702 r4836  
    11/*!
    22    \file bv_tree.h
    3     \brief Definition of a bounding volume tree
     3  * Definition of a bounding volume tree
    44
    55*/

  • orxonox/trunk/src/lib/collision_detection/cd_engine.cc

    r4742 r4836  
    2727
    2828/**
    29    \brief standard constructor
     29 * standard constructor
    3030*/
    3131CDEngine::CDEngine ()
    … …  
    3838
    3939/**
    40    \brief the singleton reference to this class
     40 * the singleton reference to this class
    4141*/
    4242CDEngine* CDEngine::singletonRef = NULL;
    4343
    4444/**
    45    \brief standard deconstructor
     45 * standard deconstructor
    4646
    4747*/

  • orxonox/trunk/src/lib/collision_detection/cd_engine.h

    r4746 r4836  
    11/*!
    22    \file cd_engine.h
    3     \brief Definition of the collision detection engine
     3  * Definition of the collision detection engine
    44
    55*/
    … …  
    3535 public:
    3636  virtual ~CDEngine();
    37   /** \returns a Pointer to the only object of this Class */
     37  /** @returns a Pointer to the only object of this Class */
    3838  static CDEngine* getInstance() { if (!singletonRef) singletonRef = new CDEngine(); return singletonRef; }
    3939  void init();

  • orxonox/trunk/src/lib/collision_detection/collision.cc

    r4511 r4836  
    2222
    2323/**
    24    \brief standard constructor
     24 * standard constructor
    2525*/
    2626Collision::Collision ()
    … …  
    3232
    3333/**
    34    \brief standard deconstructor
     34 * standard deconstructor
    3535
    3636*/

  • orxonox/trunk/src/lib/collision_detection/collision.h

    r4544 r4836  
    11/*!
    22    \file collision.h
    3     \brief Definition of a collision event
     3  * Definition of a collision event
    44
    55*/

  • orxonox/trunk/src/lib/collision_detection/collision_defs.h

    r4520 r4836  
    11/*!
    22    \file collision_defs.h
    3     \brief Definition of some global collision data
     3  * Definition of some global collision data
    44
    55*/

  • orxonox/trunk/src/lib/collision_detection/lin_alg.h

    r4746 r4836  
    11/*!
    22    \file lin_alg.h
    3     \brief Definition of some important linear algebra formulas
     3  * Definition of some important linear algebra formulas
    44
    55    compute the eigenpairs (eigenvalues and eigenvectors) of a real symmetric matrix "A" by the Jacobi method

  • orxonox/trunk/src/lib/collision_detection/obb.cc

    r4815 r4836  
    2424
    2525/**
    26    \brief standard constructor
     26 * standard constructor
    2727*/
    2828OBB::OBB ()
    … …  
    3737
    3838/**
    39    \brief standard deconstructor
     39 * standard deconstructor
    4040
    4141*/

  • orxonox/trunk/src/lib/collision_detection/obb.h

    r4814 r4836  
    11/*!
    22    \file obb.h
    3     \brief Definition of an OBB (object Oriented Bounding Box)
     3  * Definition of an OBB (object Oriented Bounding Box)
    44
    55*/

  • orxonox/trunk/src/lib/collision_detection/obb_tree.cc

    r4814 r4836  
    2828
    2929/**
    30    \brief standard constructor
     30 * standard constructor
    3131*/
    3232OBBTree::OBBTree ()
    … …  
    8282
    8383/**
    84    \brief standard deconstructor
     84 * standard deconstructor
    8585
    8686*/

  • orxonox/trunk/src/lib/collision_detection/obb_tree.h

    r4702 r4836  
    11/*!
    22    \file obb_tree.h
    3     \brief Definition of an obb tree (object oriented Bounding Box)
     3  * Definition of an obb tree (object oriented Bounding Box)
    44
    55*/

  • orxonox/trunk/src/lib/collision_detection/obb_tree_node.cc

    r4815 r4836  
    4343
    4444/**
    45    \brief standard constructor
     45 * standard constructor
    4646 */
    4747OBBTreeNode::OBBTreeNode ()
    … …  
    7676
    7777/**
    78    \brief standard deconstructor
     78 * standard deconstructor
    7979 */
    8080OBBTreeNode::~OBBTreeNode ()
    … …  
    9898
    9999/**
    100    \brief creates a new BVTree or BVTree partition
    101    \param depth: how much more depth-steps to go: if == 1 don't go any deeper!
    102    \param verticesList: the list of vertices of the object - each vertices triple is interpreted as a triangle
     100 * creates a new BVTree or BVTree partition
     101 * @param depth: how much more depth-steps to go: if == 1 don't go any deeper!
     102 * @param verticesList: the list of vertices of the object - each vertices triple is interpreted as a triangle
    103103 */
    104104void OBBTreeNode::spawnBVTree(const int depth, sVec3D *verticesList, const int length)
    … …  
    494494/**
    495495  \brief this separates an ob-box in the middle
    496   \param box: the box to separate
     496* @param box: the box to separate
    497497
    498498  this will separate the box into to smaller boxes. the separation is done along the middle of the longest axis

  • orxonox/trunk/src/lib/collision_detection/obb_tree_node.h

    r4746 r4836  
    11/*!
    22    \file bv_tree.h
    3     \brief Definition of a bounding volume tree
     3  * Definition of a bounding volume tree
    44
    55 */
    … …  
    6060    static OBBTree*     obbTree;                    //!< reference to the obb tree
    6161    Plane*              separationPlane;            //!< the separation plane of the obb
    62     sVec3D*             sepPlaneCenter;             //!< only needed to draw plane \todo: separationPlane drawing
     62    sVec3D*             sepPlaneCenter;             //!< only needed to draw plane @todo: separationPlane drawing
    6363    int                 longestAxisIndex;           //!< only needed to draw plane
    6464

  • orxonox/trunk/src/lib/coord/null_parent.cc

    r4448 r4836  
    2525
    2626/**
    27    \returns the Reference to the NullParent
     27 * @returns the Reference to the NullParent
    2828*/
    2929NullParent* NullParent::getInstance ()
    … …  
    3535
    3636/**
    37    \brief creates the one and only NullParent
    38    \param absCoordinate the cordinate of the Parent (normally Vector(0,0,0))
     37 * creates the one and only NullParent
     38 * @param absCoordinate the cordinate of the Parent (normally Vector(0,0,0))
    3939*/
    4040NullParent::NullParent (const Vector& absCoordinate) : PNode (absCoordinate, NULL)
    … …  
    4949
    5050/**
    51    \brief standard deconstructor
     51 * standard deconstructor
    5252*/
    5353NullParent::~NullParent ()

  • orxonox/trunk/src/lib/coord/null_parent.h

    r4448 r4836  
    11/*!
    22    \file null_parent.h
    3     \brief Definition of the NullParent, the higest PNode of them all.
     3  * Definition of the NullParent, the higest PNode of them all.
    44*/
    55

  • orxonox/trunk/src/lib/coord/p_node.cc

    r4785 r4836  
    1515   co-programmer:
    1616
    17    \todo Smooth-Parent: delay, speed
     17   @todo Smooth-Parent: delay, speed
    1818*/
    1919
    … …  
    4040
    4141/**
    42    \brief standard constructor
     42 * standard constructor
    4343*/
    4444PNode::PNode ()
    … …  
    5050
    5151/**
    52    \param root the load-Element for the PNode
     52 * @param root the load-Element for the PNode
    5353*/
    5454PNode::PNode(const TiXmlElement* root)
    … …  
    6262
    6363/**
    64    \brief constructor with coodinates
    65    \param absCoordinate the Absolute coordinate of the Object
    66    \param parent The parent-node of this node.
     64 * constructor with coodinates
     65 * @param absCoordinate the Absolute coordinate of the Object
     66 * @param parent The parent-node of this node.
    6767*/
    6868PNode::PNode (const Vector& absCoordinate, PNode* parent )
    … …  
    8080
    8181/**
    82    \brief standard deconstructor
     82 * standard deconstructor
    8383*/
    8484PNode::~PNode ()
    … …  
    9898
    9999/**
    100    \brief initializes a PNode
    101    \param parent the parent for this PNode
     100 * initializes a PNode
     101 * @param parent the parent for this PNode
    102102*/
    103103void PNode::init(PNode* parent)
    … …  
    113113
    114114/**
    115    \brief loads parameters of the PNode
    116    \param root the XML-element to load the properties of
     115 * loads parameters of the PNode
     116 * @param root the XML-element to load the properties of
    117117*/
    118118void PNode::loadParams(const TiXmlElement* root)
    … …  
    153153
    154154/**
    155    \brief set relative coordinates
    156    \param relCoord relative coordinates to its parent
     155 * set relative coordinates
     156 * @param relCoord relative coordinates to its parent
    157157
    158158   it is very importand, that you use this function, if you want to update the
    … …  
    167167
    168168/**
    169    \brief set relative coordinates
    170    \param x x-relative coordinates to its parent
    171    \param y y-relative coordinates to its parent
    172    \param z z-relative coordinates to its parent
     169 * set relative coordinates
     170 * @param x x-relative coordinates to its parent
     171 * @param y y-relative coordinates to its parent
     172 * @param z z-relative coordinates to its parent
    173173   \see  void PNode::setRelCoor (const Vector& relCoord)
    174174*/
    … …  
    179179
    180180/**
    181    \param absCoord set absolute coordinate
     181 * @param absCoord set absolute coordinate
    182182
    183183   it is very importand, that you use this function, if you want to update the
    … …  
    192192
    193193/**
    194  * \param x x-coordinate.
    195  * \param y y-coordinate.
    196  * \param z z-coordinate.
     194 * @param x x-coordinate.
     195 * @param y y-coordinate.
     196 * @param z z-coordinate.
    197197 * \see void PNode::setAbsCoor (const Vector& absCoord)
    198198 */
    … …  
    203203
    204204/**
    205    \brief shift coordinate (abs and rel)
    206    \param shift shift vector
     205 * shift coordinate (abs and rel)
     206 * @param shift shift vector
    207207
    208208   this function shifts the current coordinates about the vector shift. this is
    … …  
    237237
    238238/**
    239    \brief set relative direction
    240    \param relDir to its parent
     239 * set relative direction
     240 * @param relDir to its parent
    241241
    242242   it is very importand, that you use this function, if you want to update the
    … …  
    264264
    265265/**
    266    \brief sets the absolute direction (0,0,1)
    267    \param absDir absolute coordinates
     266 * sets the absolute direction (0,0,1)
     267 * @param absDir absolute coordinates
    268268
    269269   it is very importand, that you use this function, if you want to update the
    … …  
    291291
    292292/**
    293    \brief shift coordinate (abs and rel)
    294    \param shift vector
     293 * shift coordinate (abs and rel)
     294 * @param shift vector
    295295
    296296   this function shifts the current coordinates about the vector shift. this is
    … …  
    309309   yea right... shorter...
    310310
    311    \todo implement this
     311   @todo implement this
    312312*/
    313313void PNode::shiftDir (const Quaternion& shift)
    … …  
    318318
    319319/**
    320    \brief adds a child and makes this node to a parent
    321    \param pNode child reference
    322    \param parentMode on which changes the child should also change ist state
     320 * adds a child and makes this node to a parent
     321 * @param pNode child reference
     322 * @param parentMode on which changes the child should also change ist state
    323323
    324324   use this to add a child to this node.
    … …  
    349349
    350350/**
    351    \brief removes a child from the node
    352    \param pNode the child to remove from this pNode.
     351 * removes a child from the node
     352 * @param pNode the child to remove from this pNode.
    353353
    354354   Children from pNode will not be lost, they are referenced to NullPointer
    … …  
    363363
    364364/**
    365    \brief remove this pnode from the tree and adds all following to NullParent
     365 * remove this pnode from the tree and adds all following to NullParent
    366366
    367367   this can be the case, if an entity in the world is been destroyed.
    … …  
    385385
    386386/**
    387    \brief sets the parent of this PNode
    388    \param parent the Parent to set
     387 * sets the parent of this PNode
     388 * @param parent the Parent to set
    389389*/
    390390void PNode::setParent (PNode* parent)
    … …  
    405405
    406406/**
    407    \brief set the mode of this parent manualy
    408    \param parentMode the mode of the bind-type.
     407 * set the mode of this parent manualy
     408 * @param parentMode the mode of the bind-type.
    409409*/
    410410void PNode::setParentMode (PARENT_MODE parentMode)
    … …  
    414414
    415415/**
    416  * @brief sets the mode of this parent manually
     416 * sets the mode of this parent manually
    417417 * @param parentMode a String representing this parentingMode
    418418 */
    … …  
    433433
    434434/**
    435    \brief has to be called, if the parent coordinate has changed
     435 * has to be called, if the parent coordinate has changed
    436436
    437437   normaly this will be done by the parent itself automaticaly. If you call this, you
    … …  
    446446
    447447/**
    448    \brief updates the absCoordinate/absDirection
    449    \param dt The time passed since the last update
     448 * updates the absCoordinate/absDirection
     449 * @param dt The time passed since the last update
    450450
    451451   this is used to go through the parent-tree to update all the absolute coordinates
    … …  
    568568
    569569/**
    570    \brief displays some information about this pNode
    571    \param depth The deph into which to debug the children of this PNode to.
     570 * displays some information about this pNode
     571 * @param depth The deph into which to debug the children of this PNode to.
    572572  (0: all children will be debugged, 1: only this PNode, 2: this and direct children...)
    573    \param level The n-th level of the Node we draw (this is internal and only for nice output)
     573 * @param level The n-th level of the Node we draw (this is internal and only for nice output)
    574574*/
    575575void PNode::debug(unsigned int depth, unsigned int level) const
    … …  
    608608
    609609/**
    610   @brief displays the PNode at its position with its rotation as a cube.
     610  displays the PNode at its position with its rotation as a cube.
    611611*/
    612612void PNode::debugDraw(float size) const

  • orxonox/trunk/src/lib/coord/p_node.h

    r4771 r4836  
    11/*!
    22    \file p_node.h
    3     \brief Definition of a parenting node
     3  * Definition of a parenting node
    44
    55    parenting is how coordinates are handled in orxonox, meaning, that all coordinates
    … …  
    6262  void setRelCoor (const Vector& relCoord);
    6363  void setRelCoor (float x, float y, float z);
    64   /** \returns the relative position */
     64  /** @returns the relative position */
    6565  inline const Vector& getRelCoor () const { return this->relCoordinate; };
    6666  void setAbsCoor (const Vector& absCoord);
    6767  void setAbsCoor (float x, float y, float z);
    68   /** \returns the absolute position */
     68  /** @returns the absolute position */
    6969  inline const Vector& getAbsCoor () const { return this->absCoordinate; };
    7070  void shiftCoor (const Vector& shift);
    … …  
    7272  void setRelDir (const Quaternion& relDir);
    7373  void setRelDir (float x, float y, float z);
    74   /** \returns the relative Direction */
     74  /** @returns the relative Direction */
    7575  inline const Quaternion& getRelDir () const { return this->relDirection; };
    76   /** \returns a Vector pointing into the relative Direction */
     76  /** @returns a Vector pointing into the relative Direction */
    7777  inline Vector getRelDirV() const { return this->relDirection.apply(Vector(0,1,0)); };
    7878  void setAbsDir (const Quaternion& absDir);
    7979  void setAbsDir (float x, float y, float z);
    80   /** \returns the absolute Direction */
     80  /** @returns the absolute Direction */
    8181  inline const Quaternion& getAbsDir () const { return this->absDirection; };
    82   /** \returns a Vector pointing into the absolute Direction */
     82  /** @returns a Vector pointing into the absolute Direction */
    8383  inline Vector getAbsDirV() const { return this->absDirection.apply(Vector(0,1,0)); };
    8484  void shiftDir (const Quaternion& shift);
    8585
    86   /** \returns the Speed of the Node */
     86  /** @returns the Speed of the Node */
    8787  inline float getSpeed() const {return this->velocity.len();}
    88   /** \returns the Velocity of the Node */
     88  /** @returns the Velocity of the Node */
    8989  inline const Vector& getVelocity() const {return this->velocity;}
    9090
    … …  
    100100  void setParentMode (PARENT_MODE parentMode);
    101101  void setParentMode (const char* parentingMode);
    102   /** \returns the Parenting mode of this node */
     102  /** @returns the Parenting mode of this node */
    103103  int getParentMode() const { return this->parentMode; };
    104104
    … …  
    114114  /** \brief tells the child that the parent's Direction has changed */
    115115  inline void parentDirChanged () { this->bRelDirChanged = true; }
    116   /** \returns the last calculated coordinate */
     116  /** @returns the last calculated coordinate */
    117117  inline Vector getLastAbsCoor() {return this->lastAbsCoordinate;}
    118118

  • orxonox/trunk/src/lib/event/event.cc

    r4457 r4836  
    2222
    2323/**
    24    \brief standard constructor
     24 * standard constructor
    2525*/
    2626Event::Event ()
    … …  
    3232
    3333/**
    34    \brief standard deconstructor
     34 * standard deconstructor
    3535
    3636*/

  • orxonox/trunk/src/lib/event/event.h

    r4782 r4836  
    11/*!
    22    \file event.h
    3     \brief an abstract event
     3  * an abstract event
    44
    55*/

  • orxonox/trunk/src/lib/event/event_def.h

    r4782 r4836  
    11/*!
    22    \file event_def.h
    3     \brief some central definitions
     3  * some central definitions
    44
    55*/

  • orxonox/trunk/src/lib/event/event_handler.cc

    r4817 r4836  
    2929
    3030/**
    31    \brief standard constructor
     31 * standard constructor
    3232*/
    3333EventHandler::EventHandler ()
    … …  
    5252
    5353/**
    54    \brief the singleton reference to this class
     54 * the singleton reference to this class
    5555*/
    5656EventHandler* EventHandler::singletonRef = NULL;
    … …  
    5858
    5959/**
    60    \brief standard deconstructor
     60 * standard deconstructor
    6161
    6262*/
    … …  
    8080
    8181/**
    82    \brief initializes the event handler
     82 * initializes the event handler
    8383
    8484   this has to be called before the use of the event handler
    … …  
    9292
    9393/**
    94    \brief set the state of the event handler
    95    \param state: to which the event handler shall change
     94 * set the state of the event handler
     95 * @param state: to which the event handler shall change
    9696*/
    9797void EventHandler::setState(elState state)
    … …  
    102102
    103103/**
    104    \brief subscribe to an event
    105    \param el: the event listener that wants to subscribe itself, the listener that will be called when the evetn occures
    106    \param state: for which the listener wants to receive events
    107    \param eventType: the event type that wants to be listened for.
     104 * subscribe to an event
     105 * @param el: the event listener that wants to subscribe itself, the listener that will be called when the evetn occures
     106 * @param state: for which the listener wants to receive events
     107 * @param eventType: the event type that wants to be listened for.
    108108
    109109   This is one of the most important function of the EventHandler. If you would like to subscribe for more
    … …  
    111111   state = ES_ALL, which will subscribe your listener for all states together.
    112112 *
    113  * \todo this can also be done with the & operator, and checking for states, just set the esState to 1,2,4,8, and then 15 is equal to ES_ALL
     113 * @todo this can also be done with the & operator, and checking for states, just set the esState to 1,2,4,8, and then 15 is equal to ES_ALL
    114114*/
    115115void EventHandler::subscribe(EventListener* el, elState state, int eventType)
    … …  
    135135
    136136/**
    137    \brief unsubscribe from the EventHandler
    138    \param state: the stat in which it has been subscribed
    139    \param eventType: the event, that shall be unsubscribed
     137 * unsubscribe from the EventHandler
     138 * @param state: the stat in which it has been subscribed
     139 * @param eventType: the event, that shall be unsubscribed
    140140
    141141   if you want to unsubscribe an event listener from all subscribed events, just use the
    … …  
    150150
    151151/**
    152    \brief unsubscribe all events from a specific listener
    153    \param el: the listener that wants to unsubscribe itself
    154    \param state: the state in which the events shall be unsubscribed
     152 * unsubscribe all events from a specific listener
     153 * @param el: the listener that wants to unsubscribe itself
     154 * @param state: the state in which the events shall be unsubscribed
    155155
    156156*/
    … …  
    182182
    183183/**
    184    \brief flush all registered events
    185    \param state: a specific state
     184 * flush all registered events
     185 * @param state: a specific state
    186186*/
    187187void EventHandler::flush(elState state)
    … …  
    208208
    209209/**
    210    \brief core function of event handler: receives all events from SDL
     210 * core function of event handler: receives all events from SDL
    211211
    212212   The event from the SDL framework are collected here and distributed to all listeners.

  • orxonox/trunk/src/lib/event/event_handler.h

    r4834 r4836  
    11/*!
    22    \file event_handler.h
    3     \brief Definition of the EventHandler
     3  * Definition of the EventHandler
    44
    55*/
    … …  
    2121 public:
    2222  virtual ~EventHandler();
    23   /** \returns a Pointer to the only object of this Class */
     23  /** @returns a Pointer to the only object of this Class */
    2424  inline static EventHandler* getInstance() { if (!singletonRef) singletonRef = new EventHandler();  return singletonRef; };
    2525  void init();

  • orxonox/trunk/src/lib/event/event_listener.cc

    r4817 r4836  
    2323
    2424/**
    25    \brief standard constructor
     25 * standard constructor
    2626*/
    2727EventListener::EventListener ()
    2828{
    29    this->setClassID(CL_EVENT_LISTENER, "EventListener");
     29  this->setClassID(CL_EVENT_LISTENER, "EventListener");
    3030}
    3131
    3232
    3333/**
    34    \brief standard deconstructor
    35 
     34 *  standard deconstructor
    3635*/
    3736EventListener::~EventListener ()

  • orxonox/trunk/src/lib/event/event_listener.h

    r4457 r4836  
    11/*!
    22    \file event_listener.h
    3     \brief Definition of an event listener base class
     3  * Definition of an event listener base class
    44
    55*/
    … …  
    2121
    2222  /**
    23      \brief abstract function that processes events from the handler
    24      \param event: the event
     23   * abstract function that processes events from the handler
     24   * @param event: the event
    2525  */
    2626  virtual void process(const Event &event) = NULL;

  • orxonox/trunk/src/lib/event/key_mapper.cc

    r4834 r4836  
    9292
    9393/**
    94    \brief standard constructor
     94 * standard constructor
    9595*/
    9696KeyMapper::KeyMapper ()
    … …  
    101101
    102102/**
    103    \brief standard deconstructor
     103 * standard deconstructor
    104104*/
    105105KeyMapper::~KeyMapper ()
    … …  
    109109
    110110/**
    111    \brief loads new key bindings from a file
    112    \param filename: The path and name of the file to load the bindings from
     111 * loads new key bindings from a file
     112 * @param filename: The path and name of the file to load the bindings from
    113113*/
    114114void KeyMapper::loadKeyBindings (const char* fileName)
    … …  
    189189
    190190/**
    191    \brief this function looks up name to key index
    192    \param the name of the button
     191 * this function looks up name to key index
     192 * @param the name of the button
    193193*/
    194194int* KeyMapper::nameToIndex (char* name)
    … …  
    212212
    213213/**
    214    \brief the function maps name to key ids
    215    \param name of the key
    216    \param id of the key
     214 * the function maps name to key ids
     215 * @param name of the key
     216 * @param id of the key
    217217*/
    218218void KeyMapper::mapKeys(char* name, int keyID)
    … …  
    231231
    232232/**
    233    \brief this function gives some debug information about the key mapper class
     233 * this function gives some debug information about the key mapper class
    234234*/
    235235void KeyMapper::debug()

  • orxonox/trunk/src/lib/event/key_mapper.h

    r4457 r4836  
    11/*!
    22    \file key_mapper.h
    3     \brief a construct to map player defined keys to SDL keys
     3  * a construct to map player defined keys to SDL keys
    44
    55*/

  • orxonox/trunk/src/lib/event/key_names.h

    r4780 r4836  
    11/*!
    22    \file keynames.h
    3     \brief Key/button naming functions
     3  * Key/button naming functions
    44
    55                Converts strings to SDLK/SDL_BUTTON values and vice versa
    … …  
    99
    1010/**
    11         \brief converts a button name string to a integer representing the corresponding SDL mouse button identifier
    12         \param name: the name of the mouse button
    13         \return an int containing the SDL identifier of the mouse button or -1 if the button name is not valid
     11      * converts a button name string to a integer representing the corresponding SDL mouse button identifier
     12      * @param name: the name of the mouse button
     13      * @return an int containing the SDL identifier of the mouse button or -1 if the button name is not valid
    1414*/
    1515int buttonnameToSDLB(const char* name);
    1616
    1717/**
    18         \brief converst a SDL mouse button identifier to a name string
    19         \param button: an SDL mouse button identifier
    20         \return a pointer to a string containing the name of the mouse button
     18      * converst a SDL mouse button identifier to a name string
     19      * @param button: an SDL mouse button identifier
     20      * @return a pointer to a string containing the name of the mouse button
    2121*/
    2222char* SDLBToButtonname( int button);
    2323
    2424/**
    25         \brief converts a key name string to a integer representing the corresponding SDLK sym
    26         \param name: the name of the key
    27         \return the SDLK sym of the named key or -1 if the key name is not valid
     25      * converts a key name string to a integer representing the corresponding SDLK sym
     26      * @param name: the name of the key
     27      * @return the SDLK sym of the named key or -1 if the key name is not valid
    2828*/
    2929int keynameToSDLK(const char* name);
    3030
    3131/**
    32         \brief converts an SDLK sym to a name string
    33         \param key: the SDLK sym
    34         \return a pointer to a string containig the name of the key
     32      * converts an SDLK sym to a name string
     33      * @param key: the SDLK sym
     34      * @return a pointer to a string containig the name of the key
    3535*/
    3636char* SDLKToKeyname( int key);

  • orxonox/trunk/src/lib/graphics/graphics_engine.cc

    r4835 r4836  
    3030
    3131/**
    32    \brief standard constructor
    33    \todo this constructor is not jet implemented - do it
     32 * standard constructor
     33   @todo this constructor is not jet implemented - do it
    3434*/
    3535GraphicsEngine::GraphicsEngine ()
    … …  
    4848
    4949/**
    50    \brief The Pointer to this GraphicsEngine
     50 * The Pointer to this GraphicsEngine
    5151*/
    5252GraphicsEngine* GraphicsEngine::singletonRef = NULL;
    5353
    5454/**
    55    \brief destructs the graphicsEngine.
     55 * destructs the graphicsEngine.
    5656*/
    5757GraphicsEngine::~GraphicsEngine ()
    … …  
    103103
    104104/**
    105    \brief initializes the Video for openGL.
     105 * initializes the Video for openGL.
    106106
    107107   This has to be done only once when starting orxonox.
    … …  
    170170
    171171/**
    172    \brief Sets the GL-attributes
     172 * Sets the GL-attributes
    173173*/
    174174int GraphicsEngine::setGLattribs()
    … …  
    192192
    193193/**
    194    \brief sets the Resolution of the Screen to display the Graphics to.
    195    \param width The width of the window
    196    \param height The height of the window
    197    \param bpp bits per pixel
     194 * sets the Resolution of the Screen to display the Graphics to.
     195 * @param width The width of the window
     196 * @param height The height of the window
     197 * @param bpp bits per pixel
    198198*/
    199199int GraphicsEngine::setResolution(int width, int height, int bpp)
    … …  
    212212
    213213/**
    214    \brief sets Fullscreen mode
    215    \param fullscreen true if fullscreen, false if windowed
     214 * sets Fullscreen mode
     215 * @param fullscreen true if fullscreen, false if windowed
    216216*/
    217217void GraphicsEngine::setFullscreen(bool fullscreen)
    … …  
    225225
    226226/**
    227    \brief sets the background color
    228    \param red the red part of the background
    229    \param blue the blue part of the background
    230    \param green the green part of the background
    231    \param alpha the alpha part of the background
     227 * sets the background color
     228 * @param red the red part of the background
     229 * @param blue the blue part of the background
     230 * @param green the green part of the background
     231 * @param alpha the alpha part of the background
    232232*/
    233233void GraphicsEngine::setBackgroundColor(GLclampf red, GLclampf green, GLclampf blue, GLclampf alpha)
    … …  
    238238
    239239/**
    240    \brief Signalhandler, for when the resolution has changed
    241    \param resizeInfo SDL information about the size of the new screen size
     240 * Signalhandler, for when the resolution has changed
     241 * @param resizeInfo SDL information about the size of the new screen size
    242242*/
    243243int GraphicsEngine::resolutionChanged(const SDL_ResizeEvent& resizeInfo)
    … …  
    308308
    309309/**
    310    \brief entering 2D Mode
     310 * entering 2D Mode
    311311
    312312   this is a GL-Projection-mode, that is orthogonal, for placing the font in fron of everything else
    … …  
    341341
    342342/**
    343    \brief leaves the 2DMode again also \see Font::enter2DMode()
     343 * leaves the 2DMode again also \see Font::enter2DMode()
    344344*/
    345345void GraphicsEngine::leave2DMode()
    … …  
    355355
    356356/**
    357    \brief stores the GL_matrices
     357 * stores the GL_matrices
    358358*/
    359359void GraphicsEngine::storeMatrices()
    … …  
    374374
    375375/**
    376    \brief outputs all the Fullscreen modes.
     376 * outputs all the Fullscreen modes.
    377377*/
    378378void GraphicsEngine::listModes()
    … …  
    400400
    401401/**
    402    \brief ticks the Text
    403    \param dt the time passed
     402 * ticks the Text
     403 * @param dt the time passed
    404404*/
    405405void GraphicsEngine::tick(float dt)
    … …  
    426426
    427427/**
    428    \brief displays the Frames per second
    429    \param display if the text should be displayed
    430 
    431    \todo this is dangerous
     428 * displays the Frames per second
     429 * @param display if the text should be displayed
     430
     431   @todo this is dangerous
    432432*/
    433433void GraphicsEngine::displayFPS(bool display)
    … …  
    453453/**
    454454  \brief processes the events for orxonox main class
    455   \param the event to handle
     455* @param the event to handle
    456456 */
    457457void GraphicsEngine::process(const Event &event)

  • orxonox/trunk/src/lib/graphics/graphics_engine.h

    r4834 r4836  
    22    \file graphics_engine.h
    33
    4     \brief defines a Interface between orxonox and graphical input
     4  * defines a Interface between orxonox and graphical input
    55
    66    handles graphical SDL-initialisation, textures, resolutions, and so on
    … …  
    2727  public:
    2828    virtual ~GraphicsEngine();
    29     /** \returns a Pointer to the only object of this Class */
     29    /** @returns a Pointer to the only object of this Class */
    3030    inline static GraphicsEngine* getInstance() { if (!singletonRef) singletonRef = new GraphicsEngine();  return singletonRef; };
    3131
    … …  
    4040
    4141
    42     /** \returns the x resolution */
     42    /** @returns the x resolution */
    4343    inline int getResolutionX() const { return this->resolutionX; };
    44     /** \returns the y resolution */
     44    /** @returns the y resolution */
    4545    inline int getResolutionY() const { return this->resolutionY; };
    46     /** \returns the Bits Per Pixel */
     46    /** @returns the Bits Per Pixel */
    4747    inline int getbbp() const { return this->bitsPerPixel; };
    4848

  • orxonox/trunk/src/lib/graphics/importer/abstract_model.h

    r4809 r4836  
    1616/*!
    1717    \file abstract_model.h
    18     \brief Definition of an abstract model. containing all needed for other model
     18  * Definition of an abstract model. containing all needed for other model
    1919*/
    2020

  • orxonox/trunk/src/lib/graphics/importer/array.h

    r4799 r4836  
    3636    void addEntry(T entry0, T entry1, T entry2);
    3737
    38     /** \returns The array */
     38    /** @returns The array */
    3939    inline const T* getArray () const { return this->array; };
    40     /**   \returns The Count of entries in the Array*/
     40    /** * @returns The Count of entries in the Array*/
    4141    inline unsigned int getCount()const { return this->entryCount; };
    4242    inline int getIndex(T* entry) const;
    … …  
    6161
    6262/**
    63    \brief creates a new Array
     63 * creates a new Array
    6464*/
    6565template<class T>
    … …  
    7575
    7676/**
    77    \brief deletes an Array.
     77 * deletes an Array.
    7878   It does this by first deleting all the array-entries, and then delete the array[] itself
    7979*/
    … …  
    9595
    9696/**
    97    \brief finalizes an array.
     97 * finalizes an array.
    9898   This Function creates the array, and makes it ready to be sent to the application.
    9999*/
    … …  
    124124
    125125/**
    126    \brief adds a new Entry to the Array
    127    \param entry Entry to add.
     126 * adds a new Entry to the Array
     127 * @param entry Entry to add.
    128128*/
    129129template<class T>
    … …  
    145145
    146146/**
    147    \brief Adds 3 entries at once (convenience)
     147 * Adds 3 entries at once (convenience)
    148148*/
    149149template<class T>
    … …  
    157157
    158158/**
    159    \brief gets back the index of the entry in the array. value check
    160    \param entry: the entry to look up
    161    \returns the index in the array, -1 if not found
     159 * gets back the index of the entry in the array. value check
     160 * @param entry: the entry to look up
     161 * @returns the index in the array, -1 if not found
    162162 */
    163163template<class T>
    … …  
    176176
    177177/**
    178    \brief Simple debug info about the Array
     178 * Simple debug info about the Array
    179179*/
    180180template<class T>

  • orxonox/trunk/src/lib/graphics/importer/material.cc

    r4834 r4836  
    2525#include <string.h>
    2626
    27 //! \todo check if we are in RESOURCE MANAGER-mode
     27//! @todo check if we are in RESOURCE MANAGER-mode
    2828#include "resource_manager.h"
    2929
    … …  
    3131
    3232/**
    33    \brief creates a Material.
    34    \param mtlName Name of the Material to be added to the Material List
     33 * creates a Material.
     34 * @param mtlName Name of the Material to be added to the Material List
    3535*/
    3636Material::Material (const char* mtlName)
    … …  
    5252
    5353/**
    54     \brief deletes a Material
     54  * deletes a Material
    5555*/
    5656Material::~Material()
    … …  
    6767
    6868/**
    69    \brief sets the material with which the following Faces will be painted
     69 * sets the material with which the following Faces will be painted
    7070*/
    7171bool Material::select ()
    … …  
    9999
    100100  // setting illumination Model
    101   if (this->illumModel == 1) //! \todo make this work, if no vertex-normals are read.
     101  if (this->illumModel == 1) //! @todo make this work, if no vertex-normals are read.
    102102    glShadeModel(GL_FLAT);
    103103  else if (this->illumModel >= 2)
    … …  
    124124
    125125/**
    126    \brief Sets the Material Illumination Model.
    127    \brief illu illumination Model in int form
     126 * Sets the Material Illumination Model.
     127 * illu illumination Model in int form
    128128*/
    129129void Material::setIllum (int illum)
    … …  
    133133}
    134134/**
    135    \brief Sets the Material Illumination Model.
    136    \brief illu illumination Model in char* form
     135 * Sets the Material Illumination Model.
     136 * illu illumination Model in char* form
    137137*/void Material::setIllum (char* illum)
    138138{
    … …  
    141141
    142142/**
    143    \brief Sets the Material Diffuse Color.
    144    \param r Red Color Channel.
    145    \param g Green Color Channel.
    146    \param b Blue Color Channel.
     143 * Sets the Material Diffuse Color.
     144 * @param r Red Color Channel.
     145 * @param g Green Color Channel.
     146 * @param b Blue Color Channel.
    147147*/
    148148void Material::setDiffuse (float r, float g, float b)
    … …  
    156156}
    157157/**
    158    \brief Sets the Material Diffuse Color.
    159    \param rgb The red, green, blue channel in char format (with spaces between them)
     158 * Sets the Material Diffuse Color.
     159 * @param rgb The red, green, blue channel in char format (with spaces between them)
    160160*/
    161161void Material::setDiffuse (char* rgb)
    … …  
    167167
    168168/**
    169    \brief Sets the Material Ambient Color.
    170    \param r Red Color Channel.
    171    \param g Green Color Channel.
    172    \param b Blue Color Channel.
     169 * Sets the Material Ambient Color.
     170 * @param r Red Color Channel.
     171 * @param g Green Color Channel.
     172 * @param b Blue Color Channel.
    173173*/
    174174void Material::setAmbient (float r, float g, float b)
    … …  
    181181}
    182182/**
    183    \brief Sets the Material Ambient Color.
    184    \param rgb The red, green, blue channel in char format (with spaces between them)
     183 * Sets the Material Ambient Color.
     184 * @param rgb The red, green, blue channel in char format (with spaces between them)
    185185*/
    186186void Material::setAmbient (char* rgb)
    … …  
    192192
    193193/**
    194    \brief Sets the Material Specular Color.
    195    \param r Red Color Channel.
    196    \param g Green Color Channel.
    197    \param b Blue Color Channel.
     194 * Sets the Material Specular Color.
     195 * @param r Red Color Channel.
     196 * @param g Green Color Channel.
     197 * @param b Blue Color Channel.
    198198*/
    199199void Material::setSpecular (float r, float g, float b)
    … …  
    206206 }
    207207/**
    208    \brief Sets the Material Specular Color.
    209    \param rgb The red, green, blue channel in char format (with spaces between them)
     208 * Sets the Material Specular Color.
     209 * @param rgb The red, green, blue channel in char format (with spaces between them)
    210210*/
    211211void Material::setSpecular (char* rgb)
    … …  
    217217
    218218/**
    219    \brief Sets the Material Shininess.
    220    \param shini stes the Shininess from float.
     219 * Sets the Material Shininess.
     220 * @param shini stes the Shininess from float.
    221221*/
    222222void Material::setShininess (float shini)
    … …  
    225225}
    226226/**
    227    \brief Sets the Material Shininess.
    228    \param shini stes the Shininess from char*.
     227 * Sets the Material Shininess.
     228 * @param shini stes the Shininess from char*.
    229229*/
    230230void Material::setShininess (char* shini)
    … …  
    234234
    235235/**
    236    \brief Sets the Material Transparency.
    237    \param trans stes the Transparency from int.
     236 * Sets the Material Transparency.
     237 * @param trans stes the Transparency from int.
    238238*/
    239239void Material::setTransparency (float trans)
    … …  
    243243}
    244244/**
    245    \brief Sets the Material Transparency.
    246    \param trans stes the Transparency from char*.
     245 * Sets the Material Transparency.
     246 * @param trans stes the Transparency from char*.
    247247*/
    248248void Material::setTransparency (char* trans)
    … …  
    252252
    253253/**
    254    \brief Adds a Texture Path to the List of already existing Paths
    255    \param pathName The Path to add.
     254 * Adds a Texture Path to the List of already existing Paths
     255 * @param pathName The Path to add.
    256256*/
    257257void Material::addTexturePath(const char* pathName)
    … …  
    263263
    264264/**
    265    \brief Sets the Materials Diffuse Map
    266    \param dMap the Name of the Image to Use
     265 * Sets the Materials Diffuse Map
     266 * @param dMap the Name of the Image to Use
    267267*/
    268268void Material::setDiffuseMap(const char* dMap)
    … …  
    281281
    282282/**
    283    \brief Sets the Materials Ambient Map
    284    \param aMap the Name of the Image to Use
    285    \todo implement this
     283 * Sets the Materials Ambient Map
     284 * @param aMap the Name of the Image to Use
     285   @todo implement this
    286286*/
    287287void Material::setAmbientMap(const char* aMap)
    … …  
    292292
    293293/**
    294    \brief Sets the Materials Specular Map
    295    \param sMap the Name of the Image to Use
    296    \todo implement this
     294 * Sets the Materials Specular Map
     295 * @param sMap the Name of the Image to Use
     296   @todo implement this
    297297*/
    298298void Material::setSpecularMap(const char* sMap)
    … …  
    303303
    304304/**
    305    \brief Sets the Materials Bumpiness
    306    \param bump the Name of the Image to Use
    307    \todo implemet this
     305 * Sets the Materials Bumpiness
     306 * @param bump the Name of the Image to Use
     307   @todo implemet this
    308308*/
    309309void Material::setBump(const char* bump)

  • orxonox/trunk/src/lib/graphics/importer/material.h

    r4746 r4836  
    22  \file material.h
    33  \brief Contains the Material Class that handles Material for 3D-Objects.
    4   \todo free SDL-surface when deleting Material.
    5   \todo delete imgNameWithPath after use creation.
     4  @todo free SDL-surface when deleting Material.
     5  @todo delete imgNameWithPath after use creation.
    66*/
    77

  • orxonox/trunk/src/lib/graphics/importer/md2Model.cc

    r4787 r4836  
    101101
    102102/**
    103    \brief initializes an array of vert with the current frame scaled vertices
    104    \param verticesList: the list of vertices to interpolate between
     103 * initializes an array of vert with the current frame scaled vertices
     104 * @param verticesList: the list of vertices to interpolate between
    105105
    106106   we won't use the pVertices array directly, since its much easier and we need
    … …  
    126126/**
    127127  \brief sets the animation type
    128   \param type: animation type
     128* @param type: animation type
    129129
    130130  the animation types can be looked up in the animationType table
    … …  
    150150/**
    151151  \brief sets the time in seconds passed since the last tick
    152   \param time: in sec
     152* @param time: in sec
    153153*/
    154154void MD2Model::tick(float time)
    … …  
    320320/**
    321321  \brief this will load the whole model data (vertices, opengl command list, ...)
    322   \param fileName: the name of the model file
     322* @param fileName: the name of the model file
    323323  \return true if success
    324324*/
    … …  
    418418/**
    419419  \brief loads the skin/material stuff
    420   \param fileName: name of the skin file
     420* @param fileName: name of the skin file
    421421  \return true if success
    422422*/

  • orxonox/trunk/src/lib/graphics/importer/md2Model.h

    r4787 r4836  
    11/*!
    22    \file md2Model.h
    3     \brief Definition of an MD2 Model, a model format invented by ID Software.
     3  * Definition of an MD2 Model, a model format invented by ID Software.
    44
    55    We are deeply thankfull for all the wunderfull things id software made for us gamers!
    … …  
    142142  void setAnim(int type);
    143143  /**
    144      \brief scales the current model
    145      \param scaleFactor: the factor [0..1] to use for scaling
     144   * scales the current model
     145   * @param scaleFactor: the factor [0..1] to use for scaling
    146146  */
    147147  void scaleModel(float scaleFactor) { this->scaleFactor = scaleFactor;}

  • orxonox/trunk/src/lib/graphics/importer/model.cc

    r4834 r4836  
    3333////////////////////
    3434/**
    35    \brief creates a new ModelFaceElement
     35 * creates a new ModelFaceElement
    3636*/
    3737ModelFaceElement::ModelFaceElement()
    … …  
    4545
    4646/**
    47    \brief destroys a ModelFaceElement
     47 * destroys a ModelFaceElement
    4848*/
    4949ModelFaceElement::~ModelFaceElement()
    … …  
    5454
    5555/**
    56    \brief creates a new ModelFace
     56 * creates a new ModelFace
    5757*/
    5858ModelFace::ModelFace()
    … …  
    6969
    7070/**
    71    \brief deletes a ModelFace
     71 * deletes a ModelFace
    7272*/
    7373ModelFace::~ModelFace()
    … …  
    8383
    8484/**
    85    \brief Creates a new ModelGroup
     85 * Creates a new ModelGroup
    8686*/
    8787ModelGroup::ModelGroup()
    … …  
    9898
    9999/**
    100    \brief deletes a ModelGroup
     100 * deletes a ModelGroup
    101101*/
    102102ModelGroup::~ModelGroup()
    … …  
    111111
    112112/**
    113    \brief cleans up a ModelGroup
     113 * cleans up a ModelGroup
    114114
    115115   actually does the same as the delete Operator, but does not delete the predecessing group
    … …  
    130130/////////////
    131131/**
    132    \brief Creates a 3D-Model.
     132 * Creates a 3D-Model.
    133133
    134134   assigns it a Name and a Type
    … …  
    166166
    167167/**
    168    \brief deletes an Model.
     168 * deletes an Model.
    169169
    170170   Looks if any from model allocated space is still in use, and if so deleted it.
    … …  
    206206
    207207/**
    208    \brief Finalizes an Object. This can be done outside of the Class.
     208 * Finalizes an Object. This can be done outside of the Class.
    209209*/
    210210void Model::finalize()
    … …  
    237237//////////
    238238/**
    239    \brief Draws the Models of all Groups.
     239 * Draws the Models of all Groups.
    240240   It does this by just calling the Lists that must have been created earlier.
    241241*/
    … …  
    280280
    281281/**
    282    \brief Draws the Model number groupNumber
    283    \param groupNumber The number of the group that will be displayed.
     282 * Draws the Model number groupNumber
     283 * @param groupNumber The number of the group that will be displayed.
    284284
    285285   It does this by just calling the List that must have been created earlier.
    … …  
    312312
    313313/**
    314    \brief Draws the Model with a specific groupName
    315    \param groupName The name of the group that will be displayed.
     314 * Draws the Model with a specific groupName
     315 * @param groupName The name of the group that will be displayed.
    316316
    317317   It does this by just calling the List that must have been created earlier.
    … …  
    339339//////////
    340340/**
    341    \brief deletes all the arrays
     341 * deletes all the arrays
    342342*/
    343343bool Model::deleteArrays()
    … …  
    359359
    360360/**
    361    \brief finalizes an Model.
     361 * finalizes an Model.
    362362 * This funcion is needed, to delete all the Lists, and arrays that are no more
    363363 * needed because they are already imported into openGL.
    … …  
    375375//////////
    376376/**
    377    \brief adds a new Material to the Material List
    378    \param material the Material to add
    379    \returns the added material
     377 * adds a new Material to the Material List
     378 * @param material the Material to add
     379 * @returns the added material
    380380 *
    381381 * this also tells this Model, that all the Materials are handled externally
    … …  
    391391
    392392/**
    393    \brief adds a new Material to the Material List
    394    \param materialName the name of the Material to add
    395    \returns the added material
     393 * adds a new Material to the Material List
     394 * @param materialName the name of the Material to add
     395 * @returns the added material
    396396*/
    397397Material* Model::addMaterial(const char* materialName)
    … …  
    406406
    407407/**
    408    \brief finds a Material by its name and returns it
    409    \param materialName the Name of the material to search for.
    410    \returns the Material if found, NULL otherwise
     408 * finds a Material by its name and returns it
     409 * @param materialName the Name of the material to search for.
     410 * @returns the Material if found, NULL otherwise
    411411*/
    412412Material* Model::findMaterialByName(const char* materialName)
    … …  
    428428
    429429/**
    430    \brief parses a group String
    431    \param groupString the new Group to create
     430 * parses a group String
     431 * @param groupString the new Group to create
    432432
    433433   This function initializes a new Group.
    … …  
    452452
    453453/**
    454    \brief parses a vertex-String
    455    \param vertexString The String that will be parsed.
     454 * parses a vertex-String
     455 * @param vertexString The String that will be parsed.
    456456
    457457   If a vertex line is found this function will inject it into the vertex-Array
    … …  
    470470
    471471/**
    472    \brief parses a vertex-String
    473    \param x the X-coordinate of the Vertex to add.
    474    \param y the Y-coordinate of the Vertex to add.
    475    \param z the Z-coordinate of the Vertex to add.
     472 * parses a vertex-String
     473 * @param x the X-coordinate of the Vertex to add.
     474 * @param y the Y-coordinate of the Vertex to add.
     475 * @param z the Z-coordinate of the Vertex to add.
    476476
    477477*/
    … …  
    485485
    486486/**
    487    \brief parses a vertexNormal-String
    488    \param normalString The String that will be parsed.
     487 * parses a vertexNormal-String
     488 * @param normalString The String that will be parsed.
    489489
    490490   If a vertexNormal line is found this function will inject it into the vertexNormal-Array
    … …  
    503503
    504504/**
    505    \brief adds a VertexNormal.
    506    \param x The x coordinate of the Normal.
    507    \param y The y coordinate of the Normal.
    508    \param z The z coordinate of the Normal.
     505 * adds a VertexNormal.
     506 * @param x The x coordinate of the Normal.
     507 * @param y The y coordinate of the Normal.
     508 * @param z The z coordinate of the Normal.
    509509
    510510   If a vertexNormal line is found this function will inject it into the vertexNormal-Array
    … …  
    519519
    520520/**
    521    \brief parses a vertexTextureCoordinate-String
    522    \param vTextureString The String that will be parsed.
     521 * parses a vertexTextureCoordinate-String
     522 * @param vTextureString The String that will be parsed.
    523523
    524524   If a vertexTextureCoordinate line is found,
    … …  
    540540
    541541/**
    542    \brief adds a Texture Coordinate
    543    \param u The u coordinate of the TextureCoordinate.
    544    \param v The y coordinate of the TextureCoordinate.
     542 * adds a Texture Coordinate
     543 * @param u The u coordinate of the TextureCoordinate.
     544 * @param v The y coordinate of the TextureCoordinate.
    545545
    546546   If a TextureCoordinate line is found this function will inject it into the TextureCoordinate-Array
    … …  
    556556
    557557/**
    558    \brief parses a face-string
    559    \param faceString The String that will be parsed.
     558 * parses a face-string
     559 * @param faceString The String that will be parsed.
    560560
    561561   If a face line is found this function will add it to the glList.
    … …  
    615615
    616616/**
    617    \brief adds a new Face
    618    \param faceElemCount the number of Vertices to add to the Face.
    619    \param type The information Passed with each Vertex
     617 * adds a new Face
     618 * @param faceElemCount the number of Vertices to add to the Face.
     619 * @param type The information Passed with each Vertex
    620620*/
    621621bool Model::addFace(int faceElemCount, VERTEX_FORMAT type, ...)
    … …  
    648648
    649649/**
    650    \brief Function that selects a material, if changed in the obj file.
    651    \param matString the Material that will be set.
     650 * Function that selects a material, if changed in the obj file.
     651 * @param matString the Material that will be set.
    652652*/
    653653bool Model::setMaterial(const char* matString)
    … …  
    663663
    664664/**
    665    \brief Function that selects a material, if changed in the obj file.
    666    \param mtl the Material that will be set.
     665 * Function that selects a material, if changed in the obj file.
     666 * @param mtl the Material that will be set.
    667667*/
    668668bool Model::setMaterial(Material* mtl)
    … …  
    678678
    679679/**
    680    \brief A routine that is able to create normals.
     680 * A routine that is able to create normals.
    681681
    682682   The algorithm does the following:
    … …  
    757757////////////
    758758/**
    759    \brief reads and includes the Faces/Materials into the openGL state Machine
     759 * reads and includes the Faces/Materials into the openGL state Machine
    760760*/
    761761bool Model::importToDisplayList()
    … …  
    849849
    850850/**
    851    \brief reads and includes the Faces/Materials into the openGL state Machine
     851 * reads and includes the Faces/Materials into the openGL state Machine
    852852*/
    853853bool Model::importToVertexArray()
    … …  
    869869
    870870/**
    871    \brief builds an array of triangles, that can later on be used for obb separation and octree separation
     871 * builds an array of triangles, that can later on be used for obb separation and octree separation
    872872 */
    873873bool Model::buildTriangleList()
    … …  
    993993
    994994/**
    995    \brief Adds a Face-element (one vertex of a face) with all its information.
    996    \param elem The FaceElement to add to the OpenGL-environment.
     995 * Adds a Face-element (one vertex of a face) with all its information.
     996 * @param elem The FaceElement to add to the OpenGL-environment.
    997997
    998998   It does this by searching:
    … …  
    10341034
    10351035/**
    1036    \brief Includes a default model
     1036 * Includes a default model
    10371037
    10381038   This will inject a Cube, because this is the most basic model.

  • orxonox/trunk/src/lib/graphics/importer/model.h

    r4834 r4836  
    2424   MODEL_DISPLAY_LIST means, that a DisplayList will be built out of the model. This model will be STATIC, meaning it cannot be changed after initialisation.
    2525   MODEL_VERTEX_ARRAY means, that a VertexArray will be built out of the model. This moel will be DYNAMIX, meaning that one can change the properties from outside of the model.
    26  * \todo implement this stuff
     26 * @todo implement this stuff
    2727*/
    2828typedef enum MODEL_TYPE {
    … …  
    9090  ModelFace*   firstFace;      //!< The first Face in this group.
    9191  ModelFace*   currentFace;    //!< The current Face in this Group (the one we are currently working with.)
    92   int          faceMode;       //!< The Mode the Face is in: initially -1, 0 for FaceList opened, 1 for Material,  3 for triangle, 4 for Quad, 5+ for Poly \todo ENUM...
     92  int          faceMode;       //!< The Mode the Face is in: initially -1, 0 for FaceList opened, 1 for Material,  3 for triangle, 4 for Quad, 5+ for Poly @todo ENUM...
    9393  int          faceCount;      //!< The Number of Faces this Group holds.
    9494
    … …  
    111111  void draw(char* groupName) const;
    112112
    113   /** \returns Count of the Models (Groups) in this File */
     113  /** @returns Count of the Models (Groups) in this File */
    114114  inline int getGroupCount() const { return this->groupCount; };
    115115
    116   /** \returns a Pointer to the Vertex-Array, if it was deleted it returns NULL */
     116  /** @returns a Pointer to the Vertex-Array, if it was deleted it returns NULL */
    117117  inline const GLfloat* getVertexArray() const { return this->vertices->getArray(); };
    118   /** \returns the VertexCount of this Model */
     118  /** @returns the VertexCount of this Model */
    119119  inline unsigned int getVertexCount() const { return this->vertexCount; };
    120120
    121   /** \returns a Pointer to the Normals-Array, if it was deleted it returns NULL */
     121  /** @returns a Pointer to the Normals-Array, if it was deleted it returns NULL */
    122122  inline const GLfloat* getNormalsArray() const { return this->normals->getArray(); };
    123   /** \returns the NormalsCount of this Model */
     123  /** @returns the NormalsCount of this Model */
    124124  inline unsigned int getNormalsCount() const { return this->normalCount; };
    125125
    126   /** \returns a Pointer to the TexCoord-Array, if it was deleted it returns NULL */
     126  /** @returns a Pointer to the TexCoord-Array, if it was deleted it returns NULL */
    127127  inline const GLfloat* getTexCoordArray() const { return this->vTexture->getArray(); };
    128   /** \returns the TexCoord-Count of this Model */
     128  /** @returns the TexCoord-Count of this Model */
    129129  inline unsigned int getTexCoordCount() const { return this->texCoordCount; };
    130130
    131   /** \returns the Count of Faces of this Model */
     131  /** @returns the Count of Faces of this Model */
    132132  inline unsigned int getFaceCount() const { return this->faceCount; };
    133133
    … …  
    157157
    158158 protected:
    159   float            scaleFactor;     //!< The Factor with which the Model should be scaled. \todo maybe one wants to scale the Model after Initialisation
     159  float            scaleFactor;     //!< The Factor with which the Model should be scaled. @todo maybe one wants to scale the Model after Initialisation
    160160
    161161 private:

  • orxonox/trunk/src/lib/graphics/importer/objModel.cc

    r4371 r4836  
    2828
    2929/**
    30    \brief Crates a 3D-Model, loads in a File and scales it.
    31    \param fileName file to parse and load (must be a .obj file)
    32    \param scaling The factor that the model will be scaled with.
     30 * Crates a 3D-Model, loads in a File and scales it.
     31 * @param fileName file to parse and load (must be a .obj file)
     32 * @param scaling The factor that the model will be scaled with.
    3333*/
    3434OBJModel::OBJModel(const char* fileName, float scaling) : Model(fileName)
    … …  
    4444
    4545/**
    46    \brief deletes an OBJModel.
     46 * deletes an OBJModel.
    4747
    4848   Looks if any from model allocated space is still in use, and if so deleted it.
    … …  
    5656
    5757/**
    58    \brief Imports a obj file and handles the the relative location
    59    \param fileName The file to import
     58 * Imports a obj file and handles the the relative location
     59 * @param fileName The file to import
    6060
    6161   Splits the FileName from the DirectoryName
    … …  
    8686
    8787/**
    88    \brief Reads in the .obj File and sets all the Values.
     88 * Reads in the .obj File and sets all the Values.
    8989   This function does read the file, parses it for the occurence of things like vertices, faces and so on, and executes the specific tasks
    9090*/
    … …  
    143143          this->addGroup (buffer+2);
    144144        }
    145       else if (!strncmp(buffer, "s ", 2)) //! \todo smoothing groups have to be implemented
     145      else if (!strncmp(buffer, "s ", 2)) //! @todo smoothing groups have to be implemented
    146146        {
    147147          PRINTF(2)("smoothing groups not supportet yet. line: %s\n", buffer);
    … …  
    153153
    154154/**
    155     \brief Function to read in a mtl File.
    156     \param mtlFile The .mtl file to read
     155  * Function to read in a mtl File.
     156  * @param mtlFile The .mtl file to read
    157157
    158158    This Function parses all Lines of an mtl File.

  • orxonox/trunk/src/lib/graphics/importer/primitive_model.cc

    r4678 r4836  
    2525
    2626/**
    27    \brief Creates a 3D-Model of Primitive-Type type
     27 * Creates a 3D-Model of Primitive-Type type
    2828
    2929   if you want to just display a Cube/Sphere/Cylinder/... without any material.
    3030
    31    \todo implement Cube/Sphere/Cylinder/...
     31   @todo implement Cube/Sphere/Cylinder/...
    3232*/
    3333PrimitiveModel::PrimitiveModel(PRIMITIVE type, float size, unsigned int detail)
    … …  
    5656
    5757/**
    58    \brief standard deconstructor
     58 * standard deconstructor
    5959
    6060*/
    … …  
    6565
    6666/**
    67    \brief Builds a Sphere into the Model.
    68    \param size The diameter of the Sphere.
    69    \param detail The detail of the Sphere.
     67 * Builds a Sphere into the Model.
     68 * @param size The diameter of the Sphere.
     69 * @param detail The detail of the Sphere.
    7070*/
    7171void PrimitiveModel::sphereModel(float size, unsigned int detail)
    … …  
    132132}
    133133/**
    134    \brief Creates a Cylinder.
     134 * Creates a Cylinder.
    135135*/
    136136void PrimitiveModel::cylinderModel(float size, unsigned int detail)
    … …  
    173173
    174174/**
    175    \brief creates a cone inside of this Model
    176    \param size The size of the cone
    177    \param detail the Detail-level of this cone
     175 * creates a cone inside of this Model
     176 * @param size The size of the cone
     177 * @param detail the Detail-level of this cone
    178178*/
    179179void PrimitiveModel::coneModel(float size, unsigned int detail)
    … …  
    209209
    210210/**
    211    \brief creates a Plane inside of this Model
    212    \param size The size of this plane
    213    \param detail the Detail-level of this plane.
     211 * creates a Plane inside of this Model
     212 * @param size The size of this plane
     213 * @param detail the Detail-level of this plane.
    214214*/
    215215void PrimitiveModel::planeModel(float size, unsigned int detail)

  • orxonox/trunk/src/lib/graphics/importer/primitive_model.h

    r4468 r4836  
    11/*!
    22    \file primitive_model.h
    3     \brief a Class to handle different simple models like planes cubes spheres and so on.
     3  * a Class to handle different simple models like planes cubes spheres and so on.
    44    (cube is also an option of Model, but is extended here.
    55*/

  • orxonox/trunk/src/lib/graphics/importer/texture.cc

    r4746 r4836  
    2828
    2929/**
    30    \brief Constructor for a Texture
     30 * Constructor for a Texture
    3131*/
    3232Texture::Texture(const char* imageName)
    … …  
    3939
    4040/**
    41    \brief Destructor of a Texture
     41 * Destructor of a Texture
    4242
    4343   Frees Data, and deletes the textures from GL
    … …  
    5050
    5151/**
    52    \brief Loads a Texture to the openGL-environment.
    53    \param surface the Image to load to openGL
    54    \returns The ID of the texture.
     52 * Loads a Texture to the openGL-environment.
     53 * @param surface the Image to load to openGL
     54 * @returns The ID of the texture.
    5555*/
    5656GLuint Texture::loadTexToGL (SDL_Surface* surface)
    … …  
    139139
    140140/**
    141    \brief loads an Image from a file to a Texture
    142    \param imageName The image to load
     141 * loads an Image from a file to a Texture
     142 * @param imageName The image to load
    143143*/
    144144bool Texture::loadImage(const char* imageName)

  • orxonox/trunk/src/lib/graphics/importer/texture.h

    r4746 r4836  
    33  \brief Contains the texture class, that handles the reading of Images into Texutre-files.
    44
    5   \todo procedural textures
     5  @todo procedural textures
    66*/
    77
    … …  
    2727  ~Texture();
    2828
    29   /** \returns The textureID of this texture.  */
     29  /** @returns The textureID of this texture.  */
    3030  inline GLuint getTexture() {return this->texture;}
    3131  GLuint loadTexToGL (SDL_Surface* surface);
    32   /** \returns true if texture has alpha, false otherwise */
     32  /** @returns true if texture has alpha, false otherwise */
    3333  inline bool hasAlpha() const {return bAlpha;}
    3434

  • orxonox/trunk/src/lib/graphics/light.cc

    r4746 r4836  
    4545
    4646/**
    47  * \param root The XML-element to load the Light from
    48 
    49   \todo what to do, if no Light-Slots are open anymore ???
     47 * @param root The XML-element to load the Light from
     48
     49  @todo what to do, if no Light-Slots are open anymore ???
    5050 */
    5151 Light::Light(const TiXmlElement* root)
    … …  
    7171
    7272/**
    73    \brief destroys a Light
     73 * destroys a Light
    7474*/
    7575Light::~Light()
    … …  
    8181
    8282/**
    83  * \param root The XML-element to load the Light from
     83 * @param root The XML-element to load the Light from
    8484 */
    8585void Light::loadParams(const TiXmlElement* root)
    … …  
    104104
    105105/**
    106    \brief sets an emitting Diffuse color of this Light
    107    \param r red
    108    \param g green
    109    \param b blue
     106 * sets an emitting Diffuse color of this Light
     107 * @param r red
     108 * @param g green
     109 * @param b blue
    110110*/
    111111void Light::setDiffuseColor(GLfloat r, GLfloat g, GLfloat b)
    … …  
    120120
    121121/**
    122    \brief sets an emitting Specular color of this Light
    123    \param r red
    124    \param g green
    125    \param b blue
     122 * sets an emitting Specular color of this Light
     123 * @param r red
     124 * @param g green
     125 * @param b blue
    126126*/
    127127void Light::setSpecularColor(GLfloat r, GLfloat g, GLfloat b)
    … …  
    137137
    138138/**
    139    \brief Sets the AttenuationType of this Light Source
    140    \param constantAttenuation The Constant Attenuation of the Light
    141    \param linearAttenuation The Linear Attenuation of the Light
    142    \param quadraticAttenuation The Quadratic Attenuation of the Light
     139 * Sets the AttenuationType of this Light Source
     140 * @param constantAttenuation The Constant Attenuation of the Light
     141 * @param linearAttenuation The Linear Attenuation of the Light
     142 * @param quadraticAttenuation The Quadratic Attenuation of the Light
    143143*/
    144144void Light::setAttenuation(float constantAttenuation, float linearAttenuation, float quadraticAttenuation)
    … …  
    155155
    156156/**
    157    \brief stets the direction of the Spot Light.
    158    \param direction The direction of the Spot Light.
     157 * stets the direction of the Spot Light.
     158 * @param direction The direction of the Spot Light.
    159159*/
    160160void Light::setSpotDirection(const Vector& direction)
    … …  
    169169
    170170/**
    171    \brief sets the cutoff angle of the Light.
    172    \param cutoff The cutoff angle.
     171 * sets the cutoff angle of the Light.
     172 * @param cutoff The cutoff angle.
    173173*/
    174174void Light::setSpotCutoff(GLfloat cutoff)
    … …  
    179179
    180180/**
    181    \brief draws this Light. Being a World-entity the possibility to do this lies at hand.
     181 * draws this Light. Being a World-entity the possibility to do this lies at hand.
    182182*/
    183183void Light::draw() const
    … …  
    190190
    191191/**
    192    \brief Prints out some nice formated debug information about the Light
     192 * Prints out some nice formated debug information about the Light
    193193*/
    194194void Light::debug() const
    … …  
    213213******************/
    214214/**
    215    \brief standard constructor for a Light
     215 * standard constructor for a Light
    216216*/
    217217LightManager::LightManager ()
    … …  
    228228
    229229/**
    230    \brief standard deconstructor
     230 * standard deconstructor
    231231
    232232   first disables Lighting
    … …  
    248248
    249249/**
    250    \brief singleton-Reference to the Light-class
     250 * singleton-Reference to the Light-class
    251251*/
    252252LightManager* LightManager::singletonRef = NULL;
    253253
    254254/**
    255   \param root the XML-element to load the LightManager's settings from
     255* @param root the XML-element to load the LightManager's settings from
    256256 */
    257257void LightManager::loadParams(const TiXmlElement* root)
    … …  
    265265
    266266/**
    267   \param root The XML-element to load Lights from
     267* @param root The XML-element to load Lights from
    268268 */
    269269void LightManager::loadLights(const TiXmlElement* root)
    … …  
    281281// set Attributes
    282282/**
    283    \brief sets the ambient Color of the Scene
    284    \param r red
    285    \param g green
    286    \param b blue
     283 * sets the ambient Color of the Scene
     284 * @param r red
     285 * @param g green
     286 * @param b blue
    287287*/
    288288void LightManager::setAmbientColor(GLfloat r, GLfloat g, GLfloat b)
    … …  
    297297
    298298/**
    299   \param light the Light to register to the LightManager
     299* @param light the Light to register to the LightManager
    300300
    301301  This is done explicitely by the constructor of a Light
    … …  
    314314
    315315/**
    316   \param light The light to unregister from the LightManager
     316* @param light The light to unregister from the LightManager
    317317
    318318  This is done every time a Light is destroyed explicitely by the Light-destructor
    … …  
    333333
    334334/**
    335    \brief draws all the Lights in their appropriate position
     335 * draws all the Lights in their appropriate position
    336336 */
    337337void LightManager::draw() const
    … …  
    346346
    347347/**
    348    \brief outputs debug information about the Class and its lights
     348 * outputs debug information about the Class and its lights
    349349*/
    350350void LightManager::debug() const

  • orxonox/trunk/src/lib/graphics/light.h

    r4746 r4836  
    11/*!
    22    \file light.h
    3     \brief Handles Lights.
     3  * Handles Lights.
    44
    55    A Light is one of the more important things in a 3D-environment,
    … …  
    3838  void setSpotCutoff(GLfloat cutoff);
    3939
    40   /** \returns the lightNumber*/
     40  /** @returns the lightNumber*/
    4141  int getLightNumber() const {return this->lightNumber;}
    4242
    … …  
    9292 public:
    9393  virtual ~LightManager();
    94   /** \returns a Pointer to the only object of this Class */
     94  /** @returns a Pointer to the only object of this Class */
    9595  inline static LightManager* getInstance() { if (!singletonRef) singletonRef = new LightManager();  return singletonRef; };
    9696

  • orxonox/trunk/src/lib/graphics/spatial_separation/quadtree.cc

    r4819 r4836  
    2222
    2323/**
    24    \brief standard constructor
    25    \todo this constructor is not jet implemented - do it
     24 * standard constructor
     25   @todo this constructor is not jet implemented - do it
    2626*/
    2727Quadtree::Quadtree (modelInfo* pModelInfo)
    … …  
    3333
    3434/**
    35    \brief standard deconstructor
     35 * standard deconstructor
    3636
    3737*/
    … …  
    4343
    4444/**
    45    \brief gives the signal to separate the model into a quadtree
     45 * gives the signal to separate the model into a quadtree
    4646 */
    4747void Quadtree::separate()
    … …  
    5050
    5151/**
    52    \brief draws the debug quadtree boxes around the model
     52 * draws the debug quadtree boxes around the model
    5353 */
    5454void Quadtree::drawTree(int depth, int drawMode) const

  • orxonox/trunk/src/lib/graphics/spatial_separation/quadtree.h

    r4819 r4836  
    11/*!
    22    \file quadtree.h
    3     \brief Definition of a spatial data separation using quadtree
     3  * Definition of a spatial data separation using quadtree
    44
    55*/

  • orxonox/trunk/src/lib/graphics/spatial_separation/quadtree_node.cc

    r4819 r4836  
    2222
    2323/**
    24    \brief standard constructor
     24 * standard constructor
    2525*/
    2626QuadtreeNode::QuadtreeNode (sTriangleExt* triangles, int numTriangles, Quadtree* quadtree)
    … …  
    3131
    3232/**
    33    \brief standard deconstructor
     33 * standard deconstructor
    3434
    3535*/
    … …  
    4141
    4242/**
    43    \brief gives the signal to separate the model into a quadtree
    44    \param treeDepth the max depth, the steps to go if treeDept == 0 leaf reached
     43 * gives the signal to separate the model into a quadtree
     44 * @param treeDepth the max depth, the steps to go if treeDept == 0 leaf reached
    4545 */
    4646void QuadtreeNode::separateNode(int treeDepth)
    … …  
    4949
    5050/**
    51    \brief gives the signal to separate the model into a quadtree
    52    \param treeDepth the max depth, the steps to go if treeDept == 0 leaf reached
     51 * gives the signal to separate the model into a quadtree
     52 * @param treeDepth the max depth, the steps to go if treeDept == 0 leaf reached
    5353*/
    5454void QuadtreeNode::separateNode(float minLength)
    … …  
    5757
    5858/**
    59    \brief draws the debug quadtree boxes around the model
     59 * draws the debug quadtree boxes around the model
    6060 */
    6161void QuadtreeNode::drawTree(int depth, int drawMode) const

  • orxonox/trunk/src/lib/graphics/spatial_separation/quadtree_node.h

    r4819 r4836  
    11/*!
    22    \file proto_class.h
    3     \brief Definition of ...
     3  * Definition of ...
    44
    55*/

  • orxonox/trunk/src/lib/graphics/spatial_separation/spatial_separation.cc

    r4819 r4836  
    2424
    2525/**
    26    \brief standard constructor
    27    \param model the model that is to be separated
    28    \param overlapSize each box will overlap for a given size
     26 * standard constructor
     27 * @param model the model that is to be separated
     28 * @param overlapSize each box will overlap for a given size
    2929
    3030   The boxes are overlaping because this makes collision detection a lot simpler
    … …  
    3838
    3939/**
    40    \brief standard constructor
    41    \param model the model that is to be separated
    42    \param overlapSize each box will overlap for a given size
     40 * standard constructor
     41 * @param model the model that is to be separated
     42 * @param overlapSize each box will overlap for a given size
    4343
    4444   The boxes are overlaping because this makes collision detection a lot simpler
    … …  
    5353
    5454/**
    55    \brief standard deconstructor
     55 * standard deconstructor
    5656
    5757*/
    … …  
    6363/**
    6464  \brief creates a quadtree
    65   \param model the model to do a quadtree on
    66   \param minLength the minimal length of a quadtree node
     65* @param model the model to do a quadtree on
     66* @param minLength the minimal length of a quadtree node
    6767  \return the new quadtree
    6868 */
    … …  
    7676/**
    7777  \brief creates a quadtree
    78   \param model the model to do a quadtree on
    79   \param minLength the minimal length of a quadtree node
     78* @param model the model to do a quadtree on
     79* @param minLength the minimal length of a quadtree node
    8080  \return the new quadtree
    8181 */
    … …  
    8888/**
    8989  \brief creates a quadtree
    90   \param model the model to do a quadtree on
    91   \param minLength the minimal length of a quadtree node
     90* @param model the model to do a quadtree on
     91* @param minLength the minimal length of a quadtree node
    9292  \return the new quadtree
    9393*/
    … …  
    103103/**
    104104  \brief gets the maximal dimension of a model
    105   \param playerModel the model that this measurement is based on
     105* @param playerModel the model that this measurement is based on
    106106  \return the maximal dimension of the model
    107107 */

  • orxonox/trunk/src/lib/graphics/spatial_separation/spatial_separation.h

    r4819 r4836  
    11/*!
    22    \file spatial_separation.h
    3     \brief Definition of the generic spatial separation process of model data
     3  * Definition of the generic spatial separation process of model data
    44
    55 */

  • orxonox/trunk/src/lib/graphics/text_engine.cc

    r4834 r4836  
    4242////////////
    4343/**
    44    \brief creates a new Text Element
    45    \param font the Font to render this text in
    46    \param type The renderType to display this font in
     44 * creates a new Text Element
     45 * @param font the Font to render this text in
     46 * @param type The renderType to display this font in
    4747
    4848   this constructor is private, because the user should initialize
    … …  
    6767
    6868/**
    69    \brief deletes a Text out of memory
     69 * deletes a Text out of memory
    7070
    7171   This also ereases the text from the textList of the TextEngine
    … …  
    7777
    7878/**
    79    \brief tells the Text, that it should folow a PNode
    80    \param bindNode: the node to bind this text to
     79 * tells the Text, that it should folow a PNode
     80 * @param bindNode: the node to bind this text to
    8181*/
    8282void Text::setBindNode(PNode* bindNode)
    … …  
    8686
    8787/**
    88    \brief sets the Type of this Text
    89    \param type the type to set.
     88 * sets the Type of this Text
     89 * @param type the type to set.
    9090*/
    9191void Text::setType(int type)
    … …  
    9898
    9999/**
    100    \brief Sets a new Text to the font
    101    \param text the new text to set
     100 * Sets a new Text to the font
     101 * @param text the new text to set
    102102*/
    103103void Text::setText(const char* text)
    … …  
    129129
    130130/**
    131    \brief sets a Position.
    132    \param x the x-position in pixels from the left border
    133    \param y the y-position in pixels from the top border
     131 * sets a Position.
     132 * @param x the x-position in pixels from the left border
     133 * @param y the y-position in pixels from the top border
    134134*/
    135135void Text::setPosition(int x, int y)
    … …  
    140140
    141141/**
    142    \brief sets the text-alignment
    143    \param alignment the alignment to set
     142 * sets the text-alignment
     143 * @param alignment the alignment to set
    144144*/
    145145void Text::setAlignment(TEXT_ALIGNMENT alignment)
    … …  
    149149
    150150/**
    151    \brief sets a new color to the font
    152    \param r Red
    153    \param g Green
    154    \param b Blue
     151 * sets a new color to the font
     152 * @param r Red
     153 * @param g Green
     154 * @param b Blue
    155155*/
    156156void Text::setColor(Uint8 r, Uint8 g, Uint8 b)
    … …  
    162162
    163163/**
    164    \brief creates a texture out of the given parameters
     164 * creates a texture out of the given parameters
    165165
    166166   this has to be called every time by the user, to if changes were made.
    … …  
    185185
    186186/**
    187    \brief draws the Font
     187 * draws the Font
    188188*/
    189189void Text::draw() const
    … …  
    269269
    270270/**
    271    \brief prints out some nice debug information about this text
     271 * prints out some nice debug information about this text
    272272*/
    273273void Text::debug() const
    … …  
    285285////////////
    286286/**
    287    \brief Loads a Font from an SDL_surface into a texture.
    288    \param surface The surface to make the texture of
    289    \param texCoord The texture coordinates of the 4 corners of the texture
    290    \returns the ID of the texture
     287 * Loads a Font from an SDL_surface into a texture.
     288 * @param surface The surface to make the texture of
     289 * @param texCoord The texture coordinates of the 4 corners of the texture
     290 * @returns the ID of the texture
    291291*/
    292292GLuint Text::loadTexture(SDL_Surface *surface, TexCoord* texCoord)
    … …  
    366366
    367367/**
    368    \brief Quick utility function for texture creation
    369    \param input an integer
    370    \returns the next bigger 2^n-integer than input
     368 * Quick utility function for texture creation
     369 * @param input an integer
     370 * @returns the next bigger 2^n-integer than input
    371371*/
    372372int Text::powerOfTwo(int input)
    … …  
    385385////////////
    386386/**
    387    \brief constructs a Font
    388    \param fontFile the File to load the font from
    389    \param fontSize the Size of the Font in Pixels
    390    \param r Red value of the Font.
    391    \param g Green value of the Font.
    392    \param b Blue value of the Font.
     387 * constructs a Font
     388 * @param fontFile the File to load the font from
     389 * @param fontSize the Size of the Font in Pixels
     390 * @param r Red value of the Font.
     391 * @param g Green value of the Font.
     392 * @param b Blue value of the Font.
    393393*/
    394394Font::Font(const char* fontFile, unsigned int fontSize, Uint8 r, Uint8 g, Uint8 b)
    … …  
    413413
    414414/**
    415    \brief destructs a font
     415 * destructs a font
    416416*/
    417417Font::~Font()
    … …  
    433433
    434434/**
    435    \brief sets The Font.
    436    \param fontFile The file containing the font.
    437    \returns true if loaded, false if something went wrong, or if a font was loaded before.
     435 * sets The Font.
     436 * @param fontFile The file containing the font.
     437 * @returns true if loaded, false if something went wrong, or if a font was loaded before.
    438438*/
    439439bool Font::setFont(const char* fontFile)
    … …  
    462462
    463463/**
    464    \brief sets a specific renderStyle
    465    \param renderStyle the Style to render: a char-array containing:
     464 * sets a specific renderStyle
     465 * @param renderStyle the Style to render: a char-array containing:
    466466   i: italic, b: bold, u, underline
    467467*/
    … …  
    485485
    486486/**
    487    \brief Sets a new Size to the font
    488    \param fontSize The new Size in pixels.
     487 * Sets a new Size to the font
     488 * @param fontSize The new Size in pixels.
    489489*/
    490490void Font::setSize(unsigned int fontSize)
    … …  
    494494
    495495/**
    496    \brief sets a new color to the font
    497    \param r Red
    498    \param g Green
    499    \param b Blue
     496 * sets a new color to the font
     497 * @param r Red
     498 * @param g Green
     499 * @param b Blue
    500500*/
    501501void Font::setFastColor(Uint8 r, Uint8 g, Uint8 b)
    … …  
    507507
    508508/**
    509    \returns the maximum height of the Font, if the font was initialized, 0 otherwise
     509 * @returns the maximum height of the Font, if the font was initialized, 0 otherwise
    510510*/
    511511int Font::getMaxHeight()
    … …  
    518518
    519519/**
    520    \returns the maximum ascent of the Font, if the font was initialized, 0 otherwise
     520 * @returns the maximum ascent of the Font, if the font was initialized, 0 otherwise
    521521
    522522   the ascent is the pixels of the font above the baseline
    … …  
    531531
    532532/**
    533    \returns the maximum descent of the Font, if the font was initialized, 0 otherwise
     533 * @returns the maximum descent of the Font, if the font was initialized, 0 otherwise
    534534
    535535   the descent is the pixels of the font below the baseline
    … …  
    544544
    545545/**
    546    \param character The character to get info about.
    547    \returns a Glyph struct of a character. This Glyph is a pointer,
     546 * @param character The character to get info about.
     547 * @returns a Glyph struct of a character. This Glyph is a pointer,
    548548   and MUST be deleted by the user..
    549549
    … …  
    581581
    582582  this->initGlyphs(32, numberOfGlyphs);
    583   this->glyphArray[32]->width = fontSize/3; //!< \todo find out the real size of a Space
     583  this->glyphArray[32]->width = fontSize/3; //!< @todo find out the real size of a Space
    584584
    585585  int rectSize = this->findOptimalFastTextureSize();
    … …  
    695695
    696696/**
    697    \brief stores Glyph Metrics in an Array.
    698    \param from The Glyph to start from.
    699    \param count The number of Glyphs to start From.
     697 * stores Glyph Metrics in an Array.
     698 * @param from The Glyph to start from.
     699 * @param count The number of Glyphs to start From.
    700700*/
    701701void Font::initGlyphs(Uint16 from, Uint16 count)
    … …  
    722722
    723723/**
    724    \returns the optimal size to use as the texture size
    725 
    726    \todo: this algorithm can be a lot more faster, althought it does
     724 * @returns the optimal size to use as the texture size
     725
     726   @todo: this algorithm can be a lot more faster, althought it does
    727727   not really matter within the init-context, and 128 glyphs.
    728728
    … …  
    773773
    774774/**
    775    \brief a simple function to get some interesting information about this class
     775 * a simple function to get some interesting information about this class
    776776*/
    777777void Font::debug()
    … …  
    800800///////////////////
    801801/**
    802    \brief standard constructor
     802 * standard constructor
    803803*/
    804804TextEngine::TextEngine ()
    … …  
    812812
    813813/**
    814    \brief the singleton reference to this class
     814 * the singleton reference to this class
    815815*/
    816816TextEngine* TextEngine::singletonRef = NULL;
    817817
    818818/**
    819    \brief standard deconstructor
     819 * standard deconstructor
    820820
    821821*/
    … …  
    830830
    831831/**
    832    \brief function to enable TTF_Fonts
     832 * function to enable TTF_Fonts
    833833*/
    834834void TextEngine::enableFonts()
    … …  
    846846
    847847/**
    848    \brief function to disable TTF_fonts
     848 * function to disable TTF_fonts
    849849*/
    850850void TextEngine::disableFonts()
    … …  
    859859
    860860/**
    861    \brief creates a new Text with a certain font.
     861 * creates a new Text with a certain font.
    862862   \see Font::Font
    863863   \see Text::Text
    … …  
    884884
    885885/**
    886    \brief removes a Text from the List
    887    \param text: the text to delete
     886 * removes a Text from the List
     887 * @param text: the text to delete
    888888
    889889   this only ereases allocated memory, and removes the text
    … …  
    898898
    899899/**
    900    \brief deletes all the Text, and tries to delete all allocated fonts
     900 * deletes all the Text, and tries to delete all allocated fonts
    901901*/
    902902void TextEngine::flush()
    … …  
    913913
    914914/**
    915    \brief draws all the Texts that have been initialized
     915 * draws all the Texts that have been initialized
    916916*/
    917917void TextEngine::draw() const
    … …  
    937937
    938938/**
    939    \brief outputs some nice Debug information
    940 
    941    \todo there should also be something outputted about Font
     939 * outputs some nice Debug information
     940
     941   @todo there should also be something outputted about Font
    942942*/
    943943void TextEngine::debug() const
    … …  
    961961
    962962/**
    963    \brief checks if the compiled version and the local version of SDL_ttf match.
    964    \returns true if match, false otherwise
     963 * checks if the compiled version and the local version of SDL_ttf match.
     964 * @returns true if match, false otherwise
    965965*/
    966966bool TextEngine::checkVersion()

  • orxonox/trunk/src/lib/graphics/text_engine.h

    r4746 r4836  
    11/*!
    22    \file text_engine.h
    3     \brief Definition of textEngine, the Font and the Text
     3  * Definition of textEngine, the Font and the Text
    44
    55    Text is the text outputed.
    … …  
    116116  void setPosition(int x, int y);
    117117  void setAlignment(TEXT_ALIGNMENT alignment);
    118   /** \param blending the blending intensity to set (between 0.0 and 1.0) */
     118  /** @param blending the blending intensity to set (between 0.0 and 1.0) */
    119119  inline void setBlending(float blending) {this->blending = blending;}
    120120
    … …  
    145145  // placement in openGL
    146146  GLuint            texture;        //!< A GL-texture to hold the text
    147   TexCoord          texCoord;       //!< Texture-coordinates \todo fix this to have a struct
     147  TexCoord          texCoord;       //!< Texture-coordinates @todo fix this to have a struct
    148148  SDL_Rect          posSize;        //!< An SDL-Rectangle representing the position and size of the Text on the screen.
    149149
    … …  
    174174  void setStyle(const char* renderStyle);
    175175
    176   /** \returns a Pointer to the Array of Glyphs */
     176  /** @returns a Pointer to the Array of Glyphs */
    177177  inline Glyph** getGlyphArray() const {return glyphArray;}
    178   /** \returns the texture to the fast-texture */
     178  /** @returns the texture to the fast-texture */
    179179  inline GLuint getFastTextureID() const {return fastTextureID;}
    180180
    … …  
    217217 public:
    218218  virtual ~TextEngine();
    219   /** \returns a Pointer to the only object of this Class */
     219  /** @returns a Pointer to the only object of this Class */
    220220  inline static TextEngine* getInstance() { if (!singletonRef) singletonRef = new TextEngine();  return singletonRef; };
    221221

  • orxonox/trunk/src/lib/gui/gui.cc

    r4746 r4836  
    4848
    4949/**
    50    \brief Initializes the Gui
     50 * Initializes the Gui
    5151*/
    5252Gui::Gui(int argc, char *argv[])
    … …  
    121121
    122122/**
    123    \brief starts the OrxonoxGUI
     123 * starts the OrxonoxGUI
    124124*/
    125125void Gui::startGui()
    … …  
    138138
    139139/**
    140    \brief a bool that knows if orxonox should be started
     140 * a bool that knows if orxonox should be started
    141141*/
    142142bool Gui::startOrxonox = false;
    143143
    144144/**
    145    \brief Destructor.
     145 * Destructor.
    146146*/
    147147Gui::~Gui()

  • orxonox/trunk/src/lib/gui/gui.h

    r4746 r4836  
    33 \brief Creation of the Gui
    44
    5  \todo way to start gui without GTK (textmode) AND IMPROOVE
    6  \todo curl interface to Download cool stuff
     5 @todo way to start gui without GTK (textmode) AND IMPROOVE
     6 @todo curl interface to Download cool stuff
    77
    8  \todo widgets save themselves
    9  \todo good way to step through all the Widgets
    10  \todo label -> protected : getlabel function
     8 @todo widgets save themselves
     9 @todo good way to step through all the Widgets
     10 @todo label -> protected : getlabel function
    1111*/
    1212

  • orxonox/trunk/src/lib/gui/gui_audio.cc

    r4746 r4836  
    2929
    3030/**
    31    \brief Creates an Audio-Frame
     31 * Creates an Audio-Frame
    3232*/
    3333GuiAudio::GuiAudio()
    … …  
    7272
    7373/**
    74     \brief Destructs the Audio-Stuff
     74  * Destructs the Audio-Stuff
    7575*/
    7676GuiAudio::~GuiAudio()

  • orxonox/trunk/src/lib/gui/gui_banner.cc

    r4746 r4836  
    3232
    3333/**
    34    \brief Creates a new BannerEventBox and its content.
     34 * Creates a new BannerEventBox and its content.
    3535*/
    3636GuiBanner::GuiBanner()
    … …  
    7575    logoBox->fill(logoImage);
    7676
    77     //! \todo add the names of all the guys working on orxonox
     77    //! @todo add the names of all the guys working on orxonox
    7878    orxIsLabel = new Label("           " PACKAGE_NAME " is:\n" ORXONOX_STAFF);
    7979    logoBox->fill(orxIsLabel);
    … …  
    9090
    9191/**
    92    \brief Destructs it.
     92 * Destructs it.
    9393*/
    9494GuiBanner::~GuiBanner()

  • orxonox/trunk/src/lib/gui/gui_element.cc

    r4427 r4836  
    2424
    2525/**
    26    \brief standard constructor
    27    \todo this constructor is not jet implemented - do it
     26 * standard constructor
     27   @todo this constructor is not jet implemented - do it
    2828*/
    2929GuiElement::GuiElement ()
    … …  
    3434
    3535/**
    36    \brief standard deconstructor
     36 * standard deconstructor
    3737
    3838*/
    … …  
    4343
    4444/**
    45    \brief Every GuiElement should set this, or it could result in a SegFault.
     45 * Every GuiElement should set this, or it could result in a SegFault.
    4646*/
    4747void GuiElement::setMainWidget(Widget* widget)

  • orxonox/trunk/src/lib/gui/gui_element.h

    r4746 r4836  
    11/*!
    22    \file gui_element.h
    3     \brief Definition of ...
     3  * Definition of ...
    44
    55*/
    … …  
    1717  virtual ~GuiElement();
    1818 
    19   /** \returns the main Widget of this GuiElement. */
     19  /** @returns the main Widget of this GuiElement. */
    2020  Widget* getWidget() {return this->mainWidget;}
    2121 protected:

  • orxonox/trunk/src/lib/gui/gui_exec.cc

    r4830 r4836  
    3939
    4040/**
    41     \brief Creates the Exec-Frame
     41  * Creates the Exec-Frame
    4242*/
    4343GuiExec::GuiExec()
    … …  
    5656    {
    5757      Button* start;               //!< The start Button of orxonox.
    58       Menu* verboseMode;           //!< A Menu for setting the verbose-Mode. \todo setting up a verbose-class.
     58      Menu* verboseMode;           //!< A Menu for setting the verbose-Mode. @todo setting up a verbose-class.
    5959      CheckButton* alwaysShow;     //!< A CheckButton, for if orxonox should start with or without gui.
    6060      Button* quit;                //!< A Button to quit the Gui without starting orxonox.
    … …  
    131131
    132132/**
    133    \brief Destructs the Execution-stuff
     133 * Destructs the Execution-stuff
    134134*/
    135135GuiExec::~GuiExec()
    … …  
    144144
    145145/**
    146    \brief sets the Directory of the configuration files
    147    \param confDir the Directory for the configuration files
     146 * sets the Directory of the configuration files
     147 * @param confDir the Directory for the configuration files
    148148*/
    149149void GuiExec::setConfDir(const char* confDir)
    … …  
    161161
    162162/**
    163    \brief Sets the location of the configuration File.
    164    \param fileName the location of the configFile
     163 * Sets the location of the configuration File.
     164 * @param fileName the location of the configFile
    165165
    166166   The name will be parsed from ~/ to /home/[username] on unix and c:/Documents and Settings/username/Settings/ on Windows
    … …  
    176176
    177177/**
    178    \returns The name of the Configuration-File
     178 * @returns The name of the Configuration-File
    179179*/
    180180const char* GuiExec::getConfigFile() const
    … …  
    184184
    185185/**
    186    \brief checks if a option should be saved.
    187    \return 1 if it should 0 if not/
     186 * checks if a option should be saved.
     187 * @return 1 if it should 0 if not/
    188188*/
    189189int GuiExec::shouldsave()
    … …  
    193193
    194194/**
    195     \brief Saves the configuration-file to the Disk.\n
    196     \param widget from which Widget on should be saved.
     195  * Saves the configuration-file to the Disk.\n
     196  * @param widget from which Widget on should be saved.
    197197
    198198    this Function only opens and closes the file, in between GuiExec::writeFileText(Widget* widget) will execute the real writing process.
    … …  
    207207
    208208/**
    209    \brief Actually writes into the configuration file to the disk.
    210    \param widget from which Widget on should be saved.
    211    \param depth initially "0", and grows higher, while new Groups are bundeled.
     209 * Actually writes into the configuration file to the disk.
     210 * @param widget from which Widget on should be saved.
     211 * @param depth initially "0", and grows higher, while new Groups are bundeled.
    212212*/
    213213void GuiExec::writeFileText(Widget* widget, int depth)
    … …  
    258258
    259259/**
    260    \brief Reads in Configuration Data.
    261    \param widget from which Widget on should be saved.
     260 * Reads in Configuration Data.
     261 * @param widget from which Widget on should be saved.
    262262*/
    263263void GuiExec::readFromFile(Widget* widget)
    … …  
    307307
    308308/**
    309    \brief Maps Confugurations to the Options.
    310    \param widget which widget downwards
    311    \param varInfo Information about the Variable to read
     309 * Maps Confugurations to the Options.
     310 * @param widget which widget downwards
     311 * @param varInfo Information about the Variable to read
    312312*/
    313313void GuiExec::readFileText(Widget* widget, void* varInfo)
    … …  
    323323
    324324/**
    325    \brief Locates a Group.
    326    \param widget The Widget from where to search from
    327    \param groupName The GroupName for which to search.
    328    \param depth The Depth of the search seen from the first widget we searched from.
    329    \returns The Widget that holds the Group, or the NULL if the Group wasn't found.
    330 
    331    \todo do this in gui-gtk.
     325 * Locates a Group.
     326 * @param widget The Widget from where to search from
     327 * @param groupName The GroupName for which to search.
     328 * @param depth The Depth of the search seen from the first widget we searched from.
     329 * @returns The Widget that holds the Group, or the NULL if the Group wasn't found.
     330
     331   @todo do this in gui-gtk.
    332332*/
    333333Widget* GuiExec::locateGroup(Widget* widget, char* groupName, int depth)
    … …  
    365365
    366366/**
    367    \brief Starts ORXONOX.(not really implemented yet, but the function is there.\n
    368    \param widget the widget that executed the start command
    369    \param data additional data
     367 * Starts ORXONOX.(not really implemented yet, but the function is there.\n
     368 * @param widget the widget that executed the start command
     369 * @param data additional data
    370370
    371371   This is a Signal and can be executed through Widget::signal_connect
    … …  
    390390
    391391/**
    392    \brief Starts ORXONOX.(not really implemented yet, but the function is there.\n
    393    \param widget the widget that executed the start command
    394    \param data additional data
     392 * Starts ORXONOX.(not really implemented yet, but the function is there.\n
     393 * @param widget the widget that executed the start command
     394 * @param data additional data
    395395
    396396   This is a Signal and can be executed through Widget::signal_connect

  • orxonox/trunk/src/lib/gui/gui_flags.cc

    r4746 r4836  
    2727
    2828/**
    29    \brief Creates the Flags-Frame
     29 * Creates the Flags-Frame
    3030*/
    3131GuiFlags::GuiFlags()
    … …  
    4646
    4747/**
    48    \brief Destructs the Flags-stuff
     48 * Destructs the Flags-stuff
    4949*/
    5050GuiFlags::~GuiFlags()
    … …  
    5454
    5555/**
    56    \brief Sets the Flags from widget downwards.
    57    \param widget the Widget from which on to scan for deeper Options and their settings.
     56 * Sets the Flags from widget downwards.
     57 * @param widget the Widget from which on to scan for deeper Options and their settings.
    5858*/
    5959void GuiFlags::setTextFromFlags(Widget* widget)
    … …  
    7070
    7171/**
    72     \brief this actually sets the flagtext, and appends it to flagText
    73     \param widget like GuiFlags::setTextFromFlags(widget)
    74     \param flagInfo Information aboout the Flag that should be updated.
     72  * this actually sets the flagtext, and appends it to flagText
     73  * @param widget like GuiFlags::setTextFromFlags(widget)
     74  * @param flagInfo Information aboout the Flag that should be updated.
    7575*/
    7676void GuiFlags::flagsText(Widget* widget, void* flagInfo)

  • orxonox/trunk/src/lib/gui/gui_flags.h

    r4746 r4836  
    1717  Frame* flagsFrame;          //!< The Frame that holds the flagsDisplay.
    1818  Box* flagsBox;              //!< The Box that holds the flagsDisplay.
    19   CheckButton* shortFlags;    //!< CheckButton to change the display of short and long flags \todo show long if long not availible...
     19  CheckButton* shortFlags;    //!< CheckButton to change the display of short and long flags @todo show long if long not availible...
    2020  Label* flagsLabel;          //!< The Label of the Flags
    2121

  • orxonox/trunk/src/lib/gui/gui_gtk.cc

    r4746 r4836  
    4242
    4343/**
    44    \brief Initializes the Guis GTK-stuff.
    45    \param argc the argument count.
    46    \param argv The Argument strings.
     44 * Initializes the Guis GTK-stuff.
     45 * @param argc the argument count.
     46 * @param argv The Argument strings.
    4747*/
    4848bool initGUI(int argc, char *argv[])
    … …  
    6464
    6565/**
    66    \brief enters the GUI's main-loop
     66 * enters the GUI's main-loop
    6767*/
    6868bool mainloopGUI()
    … …  
    128128     
    129129      // here follows the rest.... this will be nasty.
    130       //! \todo finish it.
    131       //! \todo memory leek at save(); and save is a BAD word, use saveString instead, or something like it.
     130      //! @todo finish it.
     131      //! @todo memory leek at save(); and save is a BAD word, use saveString instead, or something like it.
    132132    }
    133133#endif /* HAVE_GTK2 */
    … …  
    144144////////////
    145145/**
    146    \brief constructs a Widget
     146 * constructs a Widget
    147147*/
    148148Widget::Widget()
    … …  
    153153
    154154/**
    155    \brief deletes any given Widget
     155 * deletes any given Widget
    156156   This is still pretty crappy.
    157157*/
    … …  
    170170  this->next = NULL;
    171171
    172   //!  \todo not hiding widget, deleting.
     172  //!  @todo not hiding widget, deleting.
    173173  //  this->hide();
    174174  // gtk_destroy_widget(this->widget);
    … …  
    176176
    177177/**
    178    \brief sets a new Title to a Widget
    179    \param title The new Title to set to the Widget
     178 * sets a new Title to a Widget
     179 * @param title The new Title to set to the Widget
    180180*/
    181181void Widget::setTitle(const char* title)
    … …  
    188188
    189189/**
    190    \brief makes the widget visible.
     190 * makes the widget visible.
    191191*/
    192192void Widget::show()
    … …  
    198198
    199199/**
    200    \brief hides the widget.
     200 * hides the widget.
    201201*/
    202202void Widget::hide()
    … …  
    208208
    209209/**
    210    \brief Sets the resolution of a specific widget to the given size.
    211    \param width the width of the widget to set.
    212    \param height the height of the widget to set.
     210 * Sets the resolution of a specific widget to the given size.
     211 * @param width the width of the widget to set.
     212 * @param height the height of the widget to set.
    213213*/
    214214void Widget::setSize(int width, int height)
    … …  
    220220
    221221/**
    222    \brief searches through widgets for a Name.
     222 * searches through widgets for a Name.
    223223*/
    224224Widget* Widget::findWidgetByName(char* name, unsigned int depth)
    … …  
    242242
    243243/**
    244    \brief Moves through all the Widgets downwards from this and executes the function on them.
    245    \param function must be of type void and takes a Widget* as an Input.
    246    \param depth the current depth. if > 0 then the next Widget will also be walked through.
     244 * Moves through all the Widgets downwards from this and executes the function on them.
     245 * @param function must be of type void and takes a Widget* as an Input.
     246 * @param depth the current depth. if > 0 then the next Widget will also be walked through.
    247247*/
    248248void Widget::walkThrough(void(*function)(Widget*), unsigned int depth)
    … …  
    259259
    260260/**
    261    \brief Moves through all the Widgets downwards from this and executes the function on them.
    262    \param function must be of type void and takes a Widget* as an Input.
    263    \param data Additional Data you want to pass to the function.
    264    \param depth the current depth. if > 0 then the next Widget will also be walked through.
     261 * Moves through all the Widgets downwards from this and executes the function on them.
     262 * @param function must be of type void and takes a Widget* as an Input.
     263 * @param data Additional Data you want to pass to the function.
     264 * @param depth the current depth. if > 0 then the next Widget will also be walked through.
    265265*/
    266266void Widget::walkThrough(void(*function)(Widget*, void*), void* data, unsigned int depth)
    … …  
    276276
    277277/**
    278     \brief This is for listing the options of "widget"
    279     \param widget specifies the widget that should be listed
     278  * This is for listing the options of "widget"
     279  * @param widget specifies the widget that should be listed
    280280*/
    281281void Widget::listOptionsAndGroups(Widget* widget)
    … …  
    290290
    291291/**
    292     \brief This is for listing the options of "widget"
    293     \param widget specifies the widget that should be listed
     292  * This is for listing the options of "widget"
     293  * @param widget specifies the widget that should be listed
    294294*/
    295295void Widget::listOptions(Widget* widget)
    … …  
    300300
    301301/**
    302     \brief This is for listing the options of "widget"
    303     \param widget specifies the widget that should be listed
    304     \param data A Counter, that always knows how many Options have been found yet.
     302  * This is for listing the options of "widget"
     303  * @param widget specifies the widget that should be listed
     304  * @param data A Counter, that always knows how many Options have been found yet.
    305305*/
    306306void Widget::listOptions(Widget* widget, void* data)
    … …  
    318318
    319319/**
    320     \brief This is for listing the options of "widget"
    321     \param widget specifies the widget that should be listed
    322     \param data A Counter, that always knows how many Options have been found yet.
     320  * This is for listing the options of "widget"
     321  * @param widget specifies the widget that should be listed
     322  * @param data A Counter, that always knows how many Options have been found yet.
    323323*/
    324324void Widget::printHelp(Widget* widget)
    … …  
    358358
    359359/**
    360     \brief Finds an Option by a given number(the n'th option found away from this Widget)
    361     \param number The Count of options to wait(by reference)
    362     \param depth The depth of the sarch. if 0 it will not search next pointer
     360  * Finds an Option by a given number(the n'th option found away from this Widget)
     361  * @param number The Count of options to wait(by reference)
     362  * @param depth The depth of the sarch. if 0 it will not search next pointer
    363363   
    364     \todo should return Option* would be much sexier.
     364    @todo should return Option* would be much sexier.
    365365*/
    366366Widget* Widget::findOptionByNumber(int* number, unsigned int depth)
    … …  
    387387
    388388/**
    389     \brief This is for listing the groups of "widget"
    390     \param widget specifies the widget that should be listed
     389  * This is for listing the groups of "widget"
     390  * @param widget specifies the widget that should be listed
    391391*/
    392392void Widget::listGroups(Widget* widget)
    … …  
    397397
    398398/**
    399     \brief This is for listing the Groups of "widget". It also displays the n'th number found.
    400     \param widget specifies the widget that should be listed
    401     \param data the Counter, that will show the number(this function will raise it by one if a Group is fount.
     399  * This is for listing the Groups of "widget". It also displays the n'th number found.
     400  * @param widget specifies the widget that should be listed
     401  * @param data the Counter, that will show the number(this function will raise it by one if a Group is fount.
    402402*/
    403403void Widget::listGroups(Widget* widget, void* data)
    … …  
    409409
    410410/**
    411     \brief Finds a Group by a given number(the n'th Group found away from this Widget)
    412     \param number The Count of options to wait(by reference)
    413     \param depth The depth of the sarch. if 0 it will not search next pointer
     411  * Finds a Group by a given number(the n'th Group found away from this Widget)
     412  * @param number The Count of options to wait(by reference)
     413  * @param depth The depth of the sarch. if 0 it will not search next pointer
    414414*/
    415415Widget* Widget::findGroupByNumber(int* number, unsigned int depth)
    … …  
    436436
    437437/**
    438     \brief This is for setting the option of "widget"
    439     \param widget specifies the widget that should be set.
     438  * This is for setting the option of "widget"
     439  * @param widget specifies the widget that should be set.
    440440*/
    441441void Widget::setOptions(Widget* widget)
    … …  
    446446
    447447/**
    448    \brief redraws all the Widgets down from widget
    449    \param widget The topmost Widget
    450    \param data ...
     448 * redraws all the Widgets down from widget
     449 * @param widget The topmost Widget
     450 * @param data ...
    451451*/
    452452void Widget::redrawOptions(Widget* widget)
    … …  
    457457
    458458/**
    459    \brief Walks through all the Flags given at startuptime.
     459 * Walks through all the Flags given at startuptime.
    460460*/
    461461void Widget::flagCheck(Widget* widget, void* flagName)
    … …  
    510510#ifdef HAVE_GTK2
    511511/**
    512     \brief Connect any signal to any given Sub-widget
     512  * Connect any signal to any given Sub-widget
    513513*/
    514514gulong Widget::connectSignal(char* event, gint(*signal)(GtkWidget*, GdkEvent*, void *))
    … …  
    518518
    519519/**
    520    \brief Connect a signal with additionally passing the whole Object
     520 * Connect a signal with additionally passing the whole Object
    521521*/
    522522gulong Widget::connectSignal(char* event, gint(*signal)( GtkWidget*, Widget *))
    … …  
    526526
    527527/**
    528    \brief Connect a signal with additionally passing a whole external Object
     528 * Connect a signal with additionally passing a whole external Object
    529529*/
    530530gulong Widget::connectSignal(char* event, void* extObj, gint(*signal)(GtkWidget*, GdkEvent*, void *))
    … …  
    534534
    535535/**
    536    \brief Connect a signal with additionally passing a whole external Object
     536 * Connect a signal with additionally passing a whole external Object
    537537*/
    538538gulong Widget::connectSignal(char* event, void* extObj, gint(*signal)(GtkWidget*, void *))
    … …  
    542542
    543543/**
    544    \brief Connect a signal with additionally passing a whole external Object
     544 * Connect a signal with additionally passing a whole external Object
    545545*/
    546546gulong Widget::connectSignal(char* event, void* extObj, gint(*signal)(GtkWidget*, GdkEventKey*, void *))
    … …  
    555555
    556556/**
    557    \brief Signal that does absolutely nothing
    558    \param widget The widget that initiated the Signal
    559    \param event The event-type.
    560    \param nothing nothin.
     557 * Signal that does absolutely nothing
     558 * @param widget The widget that initiated the Signal
     559 * @param event The event-type.
     560 * @param nothing nothin.
    561561*/
    562562gint Widget::doNothingSignal(GtkWidget *widget, GdkEvent* event, void* nothing)
    … …  
    569569/////////////
    570570/**
    571    \brief Constructs a Packer
     571 * Constructs a Packer
    572572*/
    573573Packer::Packer()
    … …  
    578578
    579579/**
    580    \brief Destroys a Packer.
     580 * Destroys a Packer.
    581581*/
    582582Packer::~Packer()
    … …  
    592592
    593593/**
    594    \brief Sets the group name under which all the lower widgets of this will be saved.
    595    \param name The name of the group.
     594 * Sets the group name under which all the lower widgets of this will be saved.
     595 * @param name The name of the group.
    596596*/
    597597void Packer::setGroupName(const char* name)
    … …  
    607607////////////////
    608608/**
    609    \brief Initializes a Container.
     609 * Initializes a Container.
    610610
    611611   sets the Container-Specific defaults.
    … …  
    617617
    618618/**
    619    \brief Destroys a Container.
     619 * Destroys a Container.
    620620*/
    621621Container::~Container()
    … …  
    625625
    626626/**
    627    \briefFills a Container with lowerWidget.
    628    \param lowerWidget the Widget that should be filled into the Container.
     627 * Fills a Container with lowerWidget.
     628 * @param lowerWidget the Widget that should be filled into the Container.
    629629
    630630   It does this by filling up the down pointer only if down points to NULL.
    … …  
    645645
    646646/**
    647    \param borderwidth sets the Width of the border
     647 * @param borderwidth sets the Width of the border
    648648*/
    649649void Container::setBorderWidth(int borderwidth)
    … …  
    661661
    662662/**
    663    \brief The main Window of Th Gui
     663 * The main Window of Th Gui
    664664*/
    665665Window* Window::mainWindow = NULL;     
    666666
    667667/**
    668    \brief Creating a Window with a name
    669    \param windowName the name the window should get.
     668 * Creating a Window with a name
     669 * @param windowName the name the window should get.
    670670*/
    671671Window::Window(const char* windowName)
    … …  
    692692
    693693/**
    694    \brief Destructs a Window.
     694 * Destructs a Window.
    695695*/
    696696Window::~Window()
    … …  
    700700
    701701/**
    702    \brief Adds a new Window Windows to the List of Windows.
    703    \param windowToAdd The Windows that should be added to the List
    704    \todo this instead of windowToAdd(possibly)
     702 * Adds a new Window Windows to the List of Windows.
     703 * @param windowToAdd The Windows that should be added to the List
     704   @todo this instead of windowToAdd(possibly)
    705705*/
    706706void Window::addWindow(Window* windowToAdd)
    … …  
    723723
    724724/**
    725    \brief Shows all Widgets that are included within this->widget.
     725 * Shows all Widgets that are included within this->widget.
    726726*/
    727727void Window::showall()
    … …  
    736736
    737737/**
    738    \brief Set The Window-title to title
    739    \param title title the Window should get.
     738 * Set The Window-title to title
     739 * @param title title the Window should get.
    740740*/
    741741void Window::setTitle(const char* title)
    … …  
    751751
    752752/**
    753    \brief opens up a Window and fixes the Focus to it
     753 * opens up a Window and fixes the Focus to it
    754754*/
    755755void Window::open()
    … …  
    766766
    767767/**
    768    \brief closes up a Window and removes the Focus from it
     768 * closes up a Window and removes the Focus from it
    769769*/
    770770void Window::close()
    … …  
    781781
    782782/**
    783    \brief opens up a window(not topmost Window).
     783 * opens up a window(not topmost Window).
    784784   this is the Signal that does it. !!SIGNALS ARE STATIC!!
    785    \param widget the widget that did it.
    786    \param event the event that did it.
    787    \param window the Window that should be opened
     785 * @param widget the widget that did it.
     786 * @param event the event that did it.
     787 * @param window the Window that should be opened
    788788*/
    789789#ifdef HAVE_GTK2
    … …  
    797797
    798798/**
    799    \brief closes a window(not topmost Window).
     799 * closes a window(not topmost Window).
    800800   this is the Signal that does it. !!SIGNALS ARE STATIC!!
    801    \param widget the widget that did it!
    802    \param event the event that did it!
    803    \param window the Window that should be closed
     801 * @param widget the widget that did it!
     802 * @param event the event that did it!
     803 * @param window the Window that should be closed
    804804*/
    805805#ifdef HAVE_GTK2
    … …  
    816816///////////
    817817/**
    818    \brief Creates a new Frame with name title
     818 * Creates a new Frame with name title
    819819*/
    820820Frame::Frame(const char* frameName)
    … …  
    829829
    830830/**
    831    \brief destrcucts a Frame
     831 * destrcucts a Frame
    832832*/
    833833Frame::~Frame()
    … …  
    837837
    838838/**
    839    \brief Sets the Frames name to title
    840    \param title The title the Frame should get.
     839 * Sets the Frames name to title
     840 * @param title The title the Frame should get.
    841841*/
    842842void Frame::setTitle(const char* title)
    … …  
    855855//////////////
    856856/**
    857    \brief Creates a new EventBox with name title
    858    \param eventBoxName title the Eventbox should get(only data-structure-internal)
     857 * Creates a new EventBox with name title
     858 * @param eventBoxName title the Eventbox should get(only data-structure-internal)
    859859*/
    860860EventBox::EventBox(const char* eventBoxName)
    … …  
    870870
    871871/**
    872    \brief destructs an EventBox.
     872 * destructs an EventBox.
    873873*/
    874874EventBox::~EventBox()
    … …  
    881881/////////
    882882/**
    883    \brief Creates a new Box of type boxtype
    884    \param boxtype if 'v' the Box will be vertically, if 'h' the Box will be horizontally
     883 * Creates a new Box of type boxtype
     884 * @param boxtype if 'v' the Box will be vertically, if 'h' the Box will be horizontally
    885885*/
    886886Box::Box(char boxtype)
    … …  
    897897
    898898/**
    899    \brief destructs a Box.
     899 * destructs a Box.
    900900*/
    901901Box::~Box()
    … …  
    905905
    906906/**
    907     \brief Fills a box with a given Widget.
    908     \param lowerWidget the next Widget that should be appendet to this Box
     907  * Fills a box with a given Widget.
     908  * @param lowerWidget the next Widget that should be appendet to this Box
    909909
    910910    It does this by apending the first one to its down-pointer and all its following ones to the preceding next-pointer. The last one will receive a NULL pointer as Next
    … …  
    931931////////////
    932932/**
    933    \brief Initializes a new Option.
     933 * Initializes a new Option.
    934934   sets all Option-Specific-Values to their defaults.
    935935*/
    … …  
    948948
    949949/**
    950    \brief Destroys an Option.
     950 * Destroys an Option.
    951951*/
    952952Option::~Option()
    … …  
    964964
    965965/**
    966    \param defaultValue new defaultValue for this option
     966 * @param defaultValue new defaultValue for this option
    967967*/
    968968void Option::setDefaultValue(int defaultValue)
    … …  
    972972
    973973/**
    974    \brief This sets The FlagName of an Option and defines its default Values
     974 * This sets The FlagName of an Option and defines its default Values
    975975   !! Options will be saved if flagname is different from NULL !!
    976    \param flagname the Name that will be displayed in the output
    977    \param defaultvalue the default Value for this Option(see definition of defaultvalue
     976 * @param flagname the Name that will be displayed in the output
     977 * @param defaultvalue the default Value for this Option(see definition of defaultvalue
    978978*/
    979979void Option::setFlagName(const char* flagname, int defaultvalue)
    … …  
    996996
    997997/**
    998     \brief see Option::setFlagName(char* flagname, int defaultvalue)
    999     \param flagname the Name that will be displayed in the output
    1000     \param defaultvalue the default Value for this Option(see definition of defaultvalue
    1001     \param flagnameshort a short flagname to be displayed in the output
     998  * see Option::setFlagName(char* flagname, int defaultvalue)
     999  * @param flagname the Name that will be displayed in the output
     1000  * @param defaultvalue the default Value for this Option(see definition of defaultvalue
     1001  * @param flagnameshort a short flagname to be displayed in the output
    10021002*/
    10031003void Option::setFlagName(const char* flagname, const char* flagnameshort,  int defaultvalue)
    … …  
    10371037
    10381038/**
    1039    \brief Sets the saveable-state of the option.
    1040    \param isSaveable the saveable-state to set.
     1039 * Sets the saveable-state of the option.
     1040 * @param isSaveable the saveable-state to set.
    10411041*/
    10421042void Option::saveability(bool isSaveable)
    … …  
    10461046
    10471047/**
    1048    \brief saves an Option
    1049    \returns the String that should be saved. (this string __should__ be deleted)
     1048 * saves an Option
     1049 * @returns the String that should be saved. (this string __should__ be deleted)
    10501050
    10511051   this is a default Option save
    … …  
    10591059
    10601060/**
    1061    \brief loads an Option from of its loadString
    1062    \param loadString the string from which to load the data from
     1061 * loads an Option from of its loadString
     1062 * @param loadString the string from which to load the data from
    10631063*/
    10641064void Option::load(char* loadString)
    … …  
    10701070
    10711071/**
    1072    \returns The saveable-state.
     1072 * @returns The saveable-state.
    10731073*/
    10741074bool Option::isSaveable()
    … …  
    10791079#ifdef HAVE_GTK2
    10801080/**
    1081     \brief Signal OptionChange writes the Value from the Option to its Object-Database.
    1082     \param widget The widget(Option) that has a changed Value
    1083     \param option the Option-Object that should receive the change.
     1081  * Signal OptionChange writes the Value from the Option to its Object-Database.
     1082  * @param widget The widget(Option) that has a changed Value
     1083  * @param option the Option-Object that should receive the change.
    10841084*/
    10851085gint Option::OptionChange(GtkWidget *widget, Widget* option)
    … …  
    10961096////////////
    10971097/**
    1098    \brief Creates a new Button with a buttonname
    1099    \param buttonName sets the Name of the Button
     1098 * Creates a new Button with a buttonname
     1099 * @param buttonName sets the Name of the Button
    11001100*/
    11011101Button::Button(const char* buttonName)
    … …  
    11121112
    11131113/**
    1114    \brief destructs a Button.
     1114 * destructs a Button.
    11151115*/
    11161116Button::~Button()
    … …  
    11201120
    11211121/**
    1122    \brief Sets a new name to the Button
    1123    \param title The name the Button should get
     1122 * Sets a new name to the Button
     1123 * @param title The name the Button should get
    11241124*/
    11251125void Button::setTitle(const char *title)
    … …  
    11351135
    11361136/**
    1137    \brief redraws the Button
    1138    \todo not implemented yet
     1137 * redraws the Button
     1138   @todo not implemented yet
    11391139*/
    11401140void Button::redraw()
    … …  
    11431143
    11441144/**
    1145    \brief Button can not be changed, optionChange is empty)
    1146 
    1147    \todo Actions for non-GTK-mode
     1145 * Button can not be changed, optionChange is empty)
     1146
     1147   @todo Actions for non-GTK-mode
    11481148*/
    11491149void Button::changeOption()
    … …  
    11561156/////////////////
    11571157/**
    1158    \brief Creates a new CheckButton with an ame
    1159    \param buttonName The name the CheckButton should display.
     1158 * Creates a new CheckButton with an ame
     1159 * @param buttonName The name the CheckButton should display.
    11601160*/
    11611161CheckButton::CheckButton(const char* buttonName)
    … …  
    11761176
    11771177/**
    1178    \brief destructs a CheckButton.
     1178 * destructs a CheckButton.
    11791179*/
    11801180CheckButton::~CheckButton()
    … …  
    11871187
    11881188/**
    1189    \brief Sets a new Title to a CheckButton
    1190    \param title The new Name the CheckButton should display.
     1189 * Sets a new Title to a CheckButton
     1190 * @param title The new Name the CheckButton should display.
    11911191*/
    11921192void CheckButton::setTitle(const char* title)
    … …  
    12021202
    12031203/**
    1204    \returns the Active state of the checkButton
     1204 * @returns the Active state of the checkButton
    12051205*/
    12061206bool CheckButton::isActive()
    … …  
    12121212
    12131213/**
    1214    \brief Changed the Option, call this Function
     1214 * Changed the Option, call this Function
    12151215*/
    12161216void CheckButton::changeOption()
    … …  
    12311231
    12321232/**
    1233    \brief Redraws the CheckButton(if option has changed).
     1233 * Redraws the CheckButton(if option has changed).
    12341234   Example: if new settings are loaded the Button must be redrawn for the GUI to display that Change
    12351235*/
    … …  
    12451245////////////
    12461246/**
    1247    \brief Creates a new Slider
    1248    \param slidername The data-structure-name of the slider.
    1249    \param start The minimal Value of the slider.
    1250    \param end The maximal Value of the slider.
     1247 * Creates a new Slider
     1248 * @param slidername The data-structure-name of the slider.
     1249 * @param start The minimal Value of the slider.
     1250 * @param end The maximal Value of the slider.
    12511251*/
    12521252Slider::Slider(const char* slidername, float start, float end)
    … …  
    12681268
    12691269/**
    1270    \brief destructs a Slider.
     1270 * destructs a Slider.
    12711271*/
    12721272Slider::~Slider()
    … …  
    12761276
    12771277/**
    1278    \brief sets the exactness of the widget
    1279    \param exactness count of digits after the dot
     1278 * sets the exactness of the widget
     1279 * @param exactness count of digits after the dot
    12801280*/
    12811281void Slider::setExactness(int exactness)
    … …  
    12881288
    12891289/**
    1290    \brief Setting a new value to the Slider.
     1290 * Setting a new value to the Slider.
    12911291   Maybe you also require a Slider::redraw() for this to display
    12921292*/
    … …  
    12971297
    12981298/**
    1299    \brief Redraws the widget
     1299 * Redraws the widget
    13001300   Example: see void CheckButton::redraw()
    13011301*/
    … …  
    13081308
    13091309/**
    1310    \brief Changed the Option, call this Function
     1310 * Changed the Option, call this Function
    13111311*/
    13121312void Slider::changeOption()
    … …  
    13461346//////////
    13471347/**
    1348    \brief constructs a new Menu, without adding any items to it.
    1349    \param menuName the Name the Menu gets.
     1348 * constructs a new Menu, without adding any items to it.
     1349 * @param menuName the Name the Menu gets.
    13501350*/
    13511351Menu::Menu(const char* menuName)
    … …  
    13561356
    13571357/**
    1358     \brief Creates a Menu-Item-list out of multiple input.
     1358  * Creates a Menu-Item-list out of multiple input.
    13591359    !! Consider, that the last input argument has to be "lastItem" for this to work!!
    1360     \param menuname The Database-Name of this Menu
    1361     \param ... items to be added to this Menu. !! Consider, that the last input argument has to be "lastItem" for this to work!!
     1360  * @param menuname The Database-Name of this Menu
     1361  * @param ... items to be added to this Menu. !! Consider, that the last input argument has to be "lastItem" for this to work!!
    13621362*/
    13631363Menu::Menu(char* menuname, ...)
    … …  
    13781378
    13791379/**
    1380    \brief destructs a Menu.
     1380 * destructs a Menu.
    13811381*/
    13821382Menu::~Menu()
    … …  
    13871387    {
    13881388      delete []this->currItem->name;
    1389       //! \todo destroy menu
     1389      //! @todo destroy menu
    13901390      /*
    13911391        #ifdef HAVE_GTK2
    … …  
    13991399
    14001400/**
    1401    \brief Initializes a new Menu with no items
     1401 * Initializes a new Menu with no items
    14021402*/
    14031403void Menu::init()
    … …  
    14151415
    14161416/**
    1417    \brief saves the Label of the Menu
    1418    \returns the name of the selected Menu-Item
     1417 * saves the Label of the Menu
     1418 * @returns the name of the selected Menu-Item
    14191419*/
    14201420char* Menu::save()
    … …  
    14371437
    14381438/**
    1439    \brief loads a Menu from of its loadString
    1440    \param loadString the string from which to load the data from
     1439 * loads a Menu from of its loadString
     1440 * @param loadString the string from which to load the data from
    14411441*/
    14421442void Menu::load(char* loadString)
    … …  
    14621462
    14631463/**
    1464    \brief appends a new Item to the Menu-List.
    1465    \param itemName the itemName to be appendet.
     1464 * appends a new Item to the Menu-List.
     1465 * @param itemName the itemName to be appendet.
    14661466*/
    14671467void Menu::addItem(char* itemName)
    … …  
    14901490
    14911491/**
    1492    \brief Redraws the widget
     1492 * Redraws the widget
    14931493   Example: see void CheckButton::redraw()
    14941494*/
    … …  
    15011501
    15021502/**
    1503    \brief Changed the Option, call this Function
     1503 * Changed the Option, call this Function
    15041504*/
    15051505void Menu::changeOption()
    … …  
    15201520
    15211521/**
    1522    \brief Creates a new OptionLabel with a LabelName and a Value.
    1523    \param label The name of the OptionLabel.
    1524    \param value The Value of the OptionLabel(what will be displayed).
     1522 * Creates a new OptionLabel with a LabelName and a Value.
     1523 * @param label The name of the OptionLabel.
     1524 * @param value The Value of the OptionLabel(what will be displayed).
    15251525*/
    15261526OptionLabel::OptionLabel(const char* label, const char* value)
    … …  
    15381538
    15391539/**
    1540    \brief destructs an OptionLabel.
     1540 * destructs an OptionLabel.
    15411541*/
    15421542OptionLabel::~OptionLabel()
    … …  
    15481548
    15491549/**
    1550    \brief Updates the value of an OptionLabel
    1551    \param newValue The new Name that should be displayed.
     1550 * Updates the value of an OptionLabel
     1551 * @param newValue The new Name that should be displayed.
    15521552*/
    15531553void OptionLabel::setValue(const char* newValue)
    … …  
    15621562
    15631563/**
    1564    \brief Redraws an OptionLabel(not implemented yet, but it works).
     1564 * Redraws an OptionLabel(not implemented yet, but it works).
    15651565*/
    15661566void OptionLabel::redraw()
    … …  
    15721572
    15731573/**
    1574    \brief Changed the Option, call this Function
     1574 * Changed the Option, call this Function
    15751575*/
    15761576void OptionLabel::changeOption()
    … …  
    15891589
    15901590/**
    1591    \brief creates the Optionlabel save-string
    1592    \returns the String to save.
     1591 * creates the Optionlabel save-string
     1592 * @returns the String to save.
    15931593*/
    15941594char* OptionLabel::save()
    … …  
    15981598
    15991599/**
    1600    \brief loads an Option from of its loadString
    1601    \param loadString the string from which to load the data from
     1600 * loads an Option from of its loadString
     1601 * @param loadString the string from which to load the data from
    16021602*/
    16031603void OptionLabel::load(char* loadString)
    … …  
    16111611///////////
    16121612/**
    1613    \brief Creates a new Label with a Text.
    1614    \param text The text to be displayed.
     1613 * Creates a new Label with a Text.
     1614 * @param text The text to be displayed.
    16151615*/
    16161616Label:: Label(const char* text)
    … …  
    16281628
    16291629/**
    1630    \brief destructs a Label.
     1630 * destructs a Label.
    16311631*/
    16321632Label::~Label()
    … …  
    16361636
    16371637/**
    1638    \brief Sets a new Text to a Label.
    1639    \param text The text to be inserted into the Label.
     1638 * Sets a new Text to a Label.
     1639 * @param text The text to be inserted into the Label.
    16401640*/
    16411641void Label::setTitle(const char* text)
    … …  
    16511651
    16521652/**
    1653    \brief ereases the Text of a Label
     1653 * ereases the Text of a Label
    16541654*/
    16551655void Label::ereaseText()
    … …  
    16591659
    16601660/**
    1661     \brief appends some Text to a Label
    1662     \param textToAppend The text that will be appended to this Label
     1661  * appends some Text to a Label
     1662  * @param textToAppend The text that will be appended to this Label
    16631663*/
    16641664void Label::appendText(char* textToAppend)
    … …  
    16811681
    16821682/**
    1683     \brief Appends some integer to the Label
    1684     \param intToAppend The Int that will be added.
     1683  * Appends some integer to the Label
     1684  * @param intToAppend The Int that will be added.
    16851685   
    16861686    it does this by just converting the int into a char* and send it to appendText
    … …  
    16951695
    16961696/**
    1697    \brief get the Text of a Label
    1698    \return The Text the Label holds.
     1697 * get the Text of a Label
     1698 * @return The Text the Label holds.
    16991699*/
    17001700const char* Label::getText()
    … …  
    17071707//////////////////
    17081708/**
    1709    \brief Creates a new ProgressBar.
    1710    \param label The name you want to get the ProgressBar.
     1709 * Creates a new ProgressBar.
     1710 * @param label The name you want to get the ProgressBar.
    17111711*/
    17121712ProgressBar::ProgressBar(const char* label)
    … …  
    17261726
    17271727/**
    1728    \brief destructs a ProgressBar
     1728 * destructs a ProgressBar
    17291729*/
    17301730ProgressBar::~ProgressBar()
    … …  
    17341734
    17351735/**
    1736    \brief Sets the Total size of the Bar.(ex. The maximum one can download)
     1736 * Sets the Total size of the Bar.(ex. The maximum one can download)
    17371737*/
    17381738void ProgressBar::setTotalSize(double totalSize)
    … …  
    17421742
    17431743/**
    1744    \brief Sets the progress maximum is this->totalSize
     1744 * Sets the progress maximum is this->totalSize
    17451745*/
    17461746void ProgressBar::setProgress(double progress)
    … …  
    17601760
    17611761/**
    1762     \brief returns the Progress Status
     1762  * returns the Progress Status
    17631763*/
    17641764double ProgressBar::getProgress()
    … …  
    17711771///////////
    17721772/**
    1773    \brief Creates a new Image
    1774    \param imageName the location of the Image on the Hard Disc
     1773 * Creates a new Image
     1774 * @param imageName the location of the Image on the Hard Disc
    17751775*/
    17761776Image::Image(const char* imageName)
    … …  
    17841784
    17851785/**
    1786    \brief Creates a new Image
    1787    \param imageData data to the PixBuff
     1786 * Creates a new Image
     1787 * @param imageData data to the PixBuff
    17881788*/
    17891789Image::Image(char** imageData)
    … …  
    17981798
    17991799/**
    1800    \brief destructs an Image.
     1800 * destructs an Image.
    18011801*/
    18021802Image::~Image()
    … …  
    18061806
    18071807/**
    1808     \brief Initializes a new Image
    1809     \param name the name to set to the Image
     1808  * Initializes a new Image
     1809  * @param name the name to set to the Image
    18101810*/
    18111811void Image::init(const char* name)
    … …  
    18241824/////////////////
    18251825/**
    1826    \brief Creates a new FileDialog
    1827    \param fileDialogName a Name for the Dialog
     1826 * Creates a new FileDialog
     1827 * @param fileDialogName a Name for the Dialog
    18281828*/
    18291829FileDialog::FileDialog(const char* fileDialogName)
    … …  
    18591859
    18601860/**
    1861    \brief destructs a FileDialog
     1861 * destructs a FileDialog
    18621862*/
    18631863FileDialog::~FileDialog()
    … …  
    19011901
    19021902/**
    1903    \brief disables the File Operator Buttons
     1903 * disables the File Operator Buttons
    19041904*/
    19051905void FileDialog::disableFileOpts()
    … …  
    19111911
    19121912/**
    1913    \brief The ok-button has been pressed
     1913 * The ok-button has been pressed
    19141914*/
    19151915void FileDialog::okEvent()

  • orxonox/trunk/src/lib/gui/gui_gtk.h

    r4746 r4836  
    122122
    123123  void setGroupName(const char* name);
    124   /** \returns the GroupName if existent NULL otherwise */
     124  /** @returns the GroupName if existent NULL otherwise */
    125125  inline const char* getGroupName() const {return this->groupName;}
    126126
    … …  
    364364  virtual void changeOption();
    365365
    366   char* cValue;                          //!< The Value the Label will have. \todo make private
     366  char* cValue;                          //!< The Value the Label will have. @todo make private
    367367};
    368368

  • orxonox/trunk/src/lib/gui/gui_keys.cc

    r4746 r4836  
    2929
    3030/**
    31    \brief Creates an Keyboard-Frame
     31 * Creates an Keyboard-Frame
    3232*/
    3333GuiKeys::GuiKeys()
    … …  
    7777
    7878/**
    79    \brief Destructs the Keys-stuff
     79 * Destructs the Keys-stuff
    8080*/
    8181GuiKeys::~GuiKeys()
    … …  
    9393////////////
    9494/**
    95    \brief Creates new inputs for a player
    96    \param player the name of the Player
     95 * Creates new inputs for a player
     96 * @param player the name of the Player
    9797*/
    9898PlayerKeys::PlayerKeys(char* player)
    … …  
    147147
    148148/**
    149    \returns the OpenButton of a Player
     149 * @returns the OpenButton of a Player
    150150*/
    151151Button* PlayerKeys::getOpenButton()
    … …  
    158158//////////////////
    159159/**
    160    \brief Creates new inputs for a misc
    161    \param player the name of the Misc
     160 * Creates new inputs for a misc
     161 * @param player the name of the Misc
    162162*/
    163163MiscKeys::MiscKeys()
    … …  
    212212
    213213/**
    214    \returns the OpenButton of a Misc
     214 * @returns the OpenButton of a Misc
    215215*/
    216216Button* MiscKeys::getOpenButton()
    … …  
    221221
    222222/**
    223    \brief adds a new Key.
    224    \param key the number of the Key
    225    \param name The name of the new Key.
    226    \returns A widget that has the Key-Box
     223 * adds a new Key.
     224 * @param key the number of the Key
     225 * @param name The name of the new Key.
     226 * @returns A widget that has the Key-Box
    227227*/
    228228Widget* addKey(const char* name, const char* defaultVal)
    … …  
    256256 
    257257/**
    258    \brief Function which gets keystrokes
    259    \param w the widget that released the Function.
    260    \param event The event that happened.
    261    \param Widget the Widget which will be applied.
    262    \returns Nothing
     258 * Function which gets keystrokes
     259 * @param w the widget that released the Function.
     260 * @param event The event that happened.
     261 * @param Widget the Widget which will be applied.
     262 * @returns Nothing
    263263*/
    264264gint key_cb(GtkWidget* w, GdkEventKey* event, void* inputKey)

  • orxonox/trunk/src/lib/gui/gui_update.cc

    r4774 r4836  
    3333
    3434/**
    35    \brief Creates an Update-Frame
     35 * Creates an Update-Frame
    3636*/
    3737GuiUpdate::GuiUpdate()
    … …  
    9898
    9999/**
    100    \brief Destructs the Update-stuff
     100 * Destructs the Update-stuff
    101101*/
    102102GuiUpdate::~GuiUpdate()
    … …  
    106106
    107107/**
    108    \brief checks if the Folder containing selected File is data.oxd, and if so sets it.
    109    \param
     108 * checks if the Folder containing selected File is data.oxd, and if so sets it.
     109 * @param
    110110*/
    111111bool GuiUpdate::checkDataDir(const char* fileName, void* object)
    … …  
    126126
    127127/**
    128     \brief Look what info we can get from this system
     128  * Look what info we can get from this system
    129129*/
    130130bool GuiUpdate::getSystemInfo()
    … …  
    167167
    168168/**
    169    \brief Creates a window, and all it contains for the Data-update.
     169 * Creates a window, and all it contains for the Data-update.
    170170*/
    171171void GuiUpdate::updateDataWindowCreate()
    … …  
    206206
    207207/**
    208    \returns A Pointer to the Button of the UpdaterDataWindow
     208 * @returns A Pointer to the Button of the UpdaterDataWindow
    209209*/
    210210Button* GuiUpdate::updateDataWindowGetButton()
    … …  
    214214
    215215/**
    216    \brief Creates a window, and all it contains for the Source-update.
     216 * Creates a window, and all it contains for the Source-update.
    217217*/
    218218void GuiUpdate::updateSourceWindowCreate()
    … …  
    245245
    246246/**
    247    \returns A Pointer to the Button of the UpdaterSourceWindow
     247 * @returns A Pointer to the Button of the UpdaterSourceWindow
    248248*/
    249249Button* GuiUpdate::updateSourceWindowGetButton()
    … …  
    255255#ifdef HAVE_GTK2
    256256/**
    257    \brief updates the Data of orxonox.
    258    \param w The widget, that executed this Function.
    259    \param event The event that trigered this Function.
    260    \param button The Button, that triggered this event.
     257 * updates the Data of orxonox.
     258 * @param w The widget, that executed this Function.
     259 * @param event The event that trigered this Function.
     260 * @param button The Button, that triggered this event.
    261261*/
    262262gint GuiUpdate::updateDataFunc(GtkWidget* w, GdkEventKey* event, void* info)
    … …  
    272272
    273273/**
    274    \brief updates the source of orxonox.
    275    \param w The widget, that executed this Function.
    276    \param event The event that trigered this Function.
    277    \param button The Button, that triggered this event.
     274 * updates the source of orxonox.
     275 * @param w The widget, that executed this Function.
     276 * @param event The event that trigered this Function.
     277 * @param button The Button, that triggered this event.
    278278*/
    279279gint GuiUpdate::updateSourceFunc(GtkWidget* w, GdkEventKey* event, void* bar)
    … …  
    286286
    287287/**
    288    \brief The Function Curl calls to write out the File.
    289    \param ptr A Pointer to the date to write.
    290    \param size The size in bytes of one nmemb to write.
    291    \param nmemb The Count of size to write.
    292    \param stream Filehandler to write to.
     288 * The Function Curl calls to write out the File.
     289 * @param ptr A Pointer to the date to write.
     290 * @param size The size in bytes of one nmemb to write.
     291 * @param nmemb The Count of size to write.
     292 * @param stream Filehandler to write to.
    293293*/
    294294size_t GuiUpdate::curlWriteFunc(void* ptr, size_t size, size_t nmemb, FILE* stream)
    … …  
    298298
    299299/**
    300    \brief The Function Curl calls to write out the File.
    301    \param ptr A Pointer to the date to write to.
    302    \param size The size in bytes of one nmemb to write.
    303    \param nmemb The Count of size to write.
    304    \param stream Filehandler to get data from.
     300 * The Function Curl calls to write out the File.
     301 * @param ptr A Pointer to the date to write to.
     302 * @param size The size in bytes of one nmemb to write.
     303 * @param nmemb The Count of size to write.
     304 * @param stream Filehandler to get data from.
    305305*/
    306306size_t GuiUpdate::curlReadFunc(void* ptr, size_t size, size_t nmemb, FILE* stream)
    … …  
    311311
    312312/**
    313    \brief An update Function for the GUI, to show the progress.
    314    \param Bar th ProgressBar to update
    315    \param totalSize The total size of the download in bytes.
    316    \param progress The current Progress of the download in bytes.
    317    \param upTotal not needed
    318    \param upProgress not needed
     313 * An update Function for the GUI, to show the progress.
     314 * @param Bar th ProgressBar to update
     315 * @param totalSize The total size of the download in bytes.
     316 * @param progress The current Progress of the download in bytes.
     317 * @param upTotal not needed
     318 * @param upProgress not needed
    319319*/
    320320int GuiUpdate::curlProgressFunc(ProgressBar* bar, double totalSize, double progress, double upTotal, double upProgress)
    … …  
    329329
    330330/**
    331    \brief The Curl handle for only one CURL(static).
     331 * The Curl handle for only one CURL(static).
    332332*/
    333333CURL* GuiUpdate::curlHandle = NULL;
    … …  
    340340
    341341/**
    342    \brief Initializes a Download without displaying it.
    343    \param fileInfo the FileInfo.
     342 * Initializes a Download without displaying it.
     343 * @param fileInfo the FileInfo.
    344344
    345345   !! BE AWARE THIS WILL NOT BE THREADED. !!
    … …  
    359359  char* fileOnNet = new char [strlen(info->webRoot)+strlen(info->fileName)+2];
    360360  strcpy(fileOnNet, info->webRoot);
    361   if(fileOnNet[strlen(fileOnNet)] != '/') //!< \todo windows-shit
     361  if(fileOnNet[strlen(fileOnNet)] != '/') //!< @todo windows-shit
    362362    strcat(fileOnNet, "/");
    363363  strcat(fileOnNet, info->fileName);
    364364  char* fileOnDisk = new char [strlen(info->localRoot)+strlen(info->fileName)+2];
    365365  strcpy(fileOnDisk, info->localRoot);
    366   if(fileOnDisk[strlen(fileOnDisk)] != '/') //!< \todo windows-shit
     366  if(fileOnDisk[strlen(fileOnDisk)] != '/') //!< @todo windows-shit
    367367    strcat(fileOnDisk, "/");
    368368  strcat(fileOnDisk, info->fileName);
    … …  
    387387
    388388/**
    389    \brief Initializes a Download with some style.
    390    \param fileInfo the FileInfo.
    391    \todo release thread-lock.
     389 * Initializes a Download with some style.
     390 * @param fileInfo the FileInfo.
     391   @todo release thread-lock.
    392392
    393393   Downloading with a Button that gets a different Name while downloading, and a Bar, that gets to be updated. More to be followed
    … …  
    447447
    448448/**
    449    \brief The downloading process(either threaded or not).
    450    \param fileInfo the FileInfo.
    451 
    452    \todo Threads get locked, if the cancel button is pressed in to small intervals.
     449 * The downloading process(either threaded or not).
     450 * @param fileInfo the FileInfo.
     451
     452   @todo Threads get locked, if the cancel button is pressed in to small intervals.
    453453*/
    454454void* GuiUpdate::downloadThread(void* fileInfo)
    … …  
    459459
    460460/**
    461    \brief Finishes a downloading process.
    462    \param fileInfo the FileInfo.
     461 * Finishes a downloading process.
     462 * @param fileInfo the FileInfo.
    463463*/
    464464void* GuiUpdate::downloadThreadFinished(void* fileInfo)
    … …  
    485485#ifdef HAVE_GTK2
    486486/**
    487    \brief canceles a downloading session.
    488    \param w The widget, that executed this Function.
    489    \param event The event that trigered this Function.
    490    \param bar The Bar, that triggered this event.
    491 
    492    \todo canceling a session in non-threaded mode.
     487 * canceles a downloading session.
     488 * @param w The widget, that executed this Function.
     489 * @param event The event that trigered this Function.
     490 * @param bar The Bar, that triggered this event.
     491
     492   @todo canceling a session in non-threaded mode.
    493493*/
    494494gint GuiUpdate::cancelDownload(GtkWidget* w, GdkEventKey* event, void* bar)

  • orxonox/trunk/src/lib/gui/gui_update.h

    r4746 r4836  
    5151  Button* updateDataBegin;              //!< A Button to start the process.
    5252
    53   Button* updateSourceWindowButton;     //!< A Button to update the Source of orxonox. \todo tricky
     53  Button* updateSourceWindowButton;     //!< A Button to update the Source of orxonox. @todo tricky
    5454  Window* updateSourceWindow;           //!< A Window for the Source-update.
    5555  Box* updateSourceBox;                 //!< A Box for the Window for the Source-update.

  • orxonox/trunk/src/lib/gui/gui_video.cc

    r4777 r4836  
    3232
    3333/**
    34    \brief Creates the Video-Option-Frame
     34 * Creates the Video-Option-Frame
    3535*/
    3636GuiVideo::GuiVideo()
    … …  
    7474
    7575/**
    76    \brief Destructs the Video-stuff
     76 * Destructs the Video-stuff
    7777*/
    7878GuiVideo::~GuiVideo()
    … …  
    8282
    8383/**
    84    \brief Creates a window, and all it contains for the Source-update.
     84 * Creates a window, and all it contains for the Source-update.
    8585*/
    8686Widget* GuiVideo::advancedWindowCreate()
    … …  
    185185
    186186/**
    187    \brief sets all resolutions to the menu
    188    \param menu the Menu to set The resolutions to.
     187 * sets all resolutions to the menu
     188 * @param menu the Menu to set The resolutions to.
    189189*/
    190190void GuiVideo::getResolutions(Menu* menu)

  • orxonox/trunk/src/lib/lang/base_object.cc

    r4815 r4836  
    2727
    2828/**
    29    \brief sets the name from a LoadXML-Element
    30    \param root the element to load from
     29 * sets the name from a LoadXML-Element
     30 * @param root the element to load from
    3131*/
    3232BaseObject::BaseObject(const TiXmlElement* root)
    … …  
    4545
    4646/**
    47    \brief standard deconstructor
     47 * standard deconstructor
    4848*/
    4949BaseObject::~BaseObject ()
    … …  
    5656
    5757/**
    58    \brief loads parameters
    59    \param root the element to load from
     58 * loads parameters
     59 * @param root the element to load from
    6060*/
    6161void BaseObject::loadParams(const TiXmlElement* root)
    … …  
    6767
    6868/**
    69    \brief sets the class identifiers
    70    \param id a number for the class from class_id.h enumeration
    71    \param className the class name
     69 * sets the class identifiers
     70 * @param id a number for the class from class_id.h enumeration
     71 * @param className the class name
    7272*/
    7373void BaseObject::setClassID(long classID, const char* className)
    … …  
    9797
    9898/**
    99    \brief checks if the class is a classID
    100    \param classID the Identifier to check for
    101    \returns true if it is, false otherwise
     99 * checks if the class is a classID
     100 * @param classID the Identifier to check for
     101 * @returns true if it is, false otherwise
    102102*/
    103103bool BaseObject::isA (long classID) const
    … …  
    118118
    119119/**
    120  * @brief displays everything this class is
     120 * displays everything this class is
    121121 */
    122122void BaseObject::whatIs() const

  • orxonox/trunk/src/lib/lang/base_object.h

    r4747 r4836  
    11/*!
    22    \file base_object.h
    3     \brief Definition of the base object class.
     3  * Definition of the base object class.
    44
    55    This is a global handler for all classes.
    … …  
    3030  inline const char* getName ()const { return this->objectName; };
    3131
    32   /** \returns the className of the corresponding Object */
     32  /** @returns the className of the corresponding Object */
    3333  inline const char* getClassName() const { return this->className; };
    34   /** \returns the classID of the corresponding Object */
     34  /** @returns the classID of the corresponding Object */
    3535  inline int getClassID() const { return this->classID; }
    3636
    … …  
    3838  void whatIs() const;
    3939
    40   /** \returns if the object is finalized */
     40  /** @returns if the object is finalized */
    4141  inline bool isFinalized() { return this->finalized; }
    4242

  • orxonox/trunk/src/lib/lang/class_list.cc

    r4815 r4836  
    2929
    3030/**
    31    \brief Creates a new ClassList
     31 * Creates a new ClassList
    3232*/
    3333ClassList::ClassList(const long& classID, const char* className)
    … …  
    4343
    4444/**
    45    \brief standard deconstructor
     45 * standard deconstructor
    4646*/
    4747ClassList::~ClassList ()

  • orxonox/trunk/src/lib/lang/class_list.h

    r4782 r4836  
    11/*!
    22    \file class_list.h
    3     \brief Definition of the Class List, that handles a Class-Specific-Control structure
     3  * Definition of the Class List, that handles a Class-Specific-Control structure
    44
    55 */

  • orxonox/trunk/src/lib/math/curve.cc

    r4746 r4836  
    3434
    3535/**
    36     \brief default constructor for a Curve
     36  * default constructor for a Curve
    3737*/
    3838Curve::Curve()
    … …  
    4848
    4949/**
    50    \brief adds a new Node to the bezier Curve
    51    \param newNode a Vector to the position of the new node
     50 * adds a new Node to the bezier Curve
     51 * @param newNode a Vector to the position of the new node
    5252*/
    5353void Curve::addNode(const Vector& newNode)
    … …  
    6565
    6666/**
    67    \brief adds a new Node to the bezier Curve
    68    \param newNode a Vector to the position of the new node
    69    \param insertPosition after the n-th node the new node will be inserted
     67 * adds a new Node to the bezier Curve
     68 * @param newNode a Vector to the position of the new node
     69 * @param insertPosition after the n-th node the new node will be inserted
    7070*/
    7171void Curve::addNode(const Vector& newNode, unsigned int insertPosition)
    … …  
    111111
    112112/**
    113    \brief Finds a Node by its Number, and returns its Position
    114    \param nodeToFind the n'th node in the List of nodes
    115    \returns A Vector to the Position of the Node.
     113 * Finds a Node by its Number, and returns its Position
     114 * @param nodeToFind the n'th node in the List of nodes
     115 * @returns A Vector to the Position of the Node.
    116116*/
    117117Vector Curve::getNode(unsigned int nodeToFind)
    … …  
    126126
    127127/**
    128    \brief Outputs information about the state of this Curve
     128 * Outputs information about the state of this Curve
    129129*/
    130130void Curve::debug()
    … …  
    148148
    149149/**
    150    \brief Creates a new BezierCurve
     150 * Creates a new BezierCurve
    151151*/
    152152BezierCurve::BezierCurve ()
    … …  
    157157
    158158/**
    159    \brief Creates a new BezierCurve-Derivation-Curve
     159 * Creates a new BezierCurve-Derivation-Curve
    160160*/
    161161BezierCurve::BezierCurve (int derivation)
    … …  
    166166
    167167/**
    168    \brief Deletes a BezierCurve.
     168 * Deletes a BezierCurve.
    169169
    170170   It does this by freeing all the space taken over from the nodes
    … …  
    185185
    186186/**
    187    \brief Rebuilds a Curve
     187 * Rebuilds a Curve
    188188*/
    189189void BezierCurve::rebuild()
    … …  
    225225
    226226/**
    227    \brief calculates the Position on the curve
    228    \param t The position on the Curve (0<=t<=1)
    229    \return the Position on the Path
     227 * calculates the Position on the curve
     228 * @param t The position on the Curve (0<=t<=1)
     229 * @return the Position on the Path
    230230*/
    231231Vector BezierCurve::calcPos(float t)
    … …  
    257257
    258258/**
    259    \brief Calulates the direction of the Curve at time t.
    260    \param t The time at which to evaluate the curve.
    261    \returns The valuated Vector.
     259 * Calulates the direction of the Curve at time t.
     260 * @param t The time at which to evaluate the curve.
     261 * @returns The valuated Vector.
    262262*/
    263263Vector BezierCurve::calcDir (float t)
    … …  
    267267
    268268/**
    269    \brief Calulates the acceleration (second derivate) of the Curve at time t.
    270    \param t The time at which to evaluate the curve.
    271    \returns The valuated Vector.
     269 * Calulates the acceleration (second derivate) of the Curve at time t.
     270 * @param t The time at which to evaluate the curve.
     271 * @returns The valuated Vector.
    272272*/
    273273Vector BezierCurve::calcAcc (float t)
    … …  
    277277
    278278/**
    279    \brief Calculates the Quaternion needed for our rotations
    280    \param t The time at which to evaluate the cuve.
    281    \returns The evaluated Quaternion.
     279 * Calculates the Quaternion needed for our rotations
     280 * @param t The time at which to evaluate the cuve.
     281 * @returns The evaluated Quaternion.
    282282*/
    283283Quaternion BezierCurve::calcQuat (float t)

  • orxonox/trunk/src/lib/math/curve.h

    r4746 r4836  
    22/*!
    33    \file curve.h
    4     \brief A basic 3D curve framework
     4  * A basic 3D curve framework
    55
    66    Contains classes to handle curves
    … …  
    3636  void addNode(const Vector& newNode, unsigned int insertPosition);
    3737  Vector getNode(unsigned int nodeToFind);
    38   /** \returns the count of nodes in this curve */
     38  /** @returns the count of nodes in this curve */
    3939  inline int getNodeCount() const { return this->nodeCount; };
    40   /** \returns the directional Curve */
     40  /** @returns the directional Curve */
    4141  Curve* getDirCurve() const { return this->dirCurve; };
    4242
    43   /** \param t the value on the curve [0-1] \returns Vector to the position */
     43  /** @param t the value on the curve [0-1] @returns Vector to the position */
    4444  virtual Vector calcPos(float t) = 0;
    45   /** \param t the value on the curve [0-1] \returns the direction */
     45  /** @param t the value on the curve [0-1] @returns the direction */
    4646  virtual Vector calcDir(float t) = 0;
    47   /** \param t the value on the curve [0-1] \returns the acceleration */
     47  /** @param t the value on the curve [0-1] @returns the acceleration */
    4848  virtual Vector calcAcc(float t) = 0;
    49   /** \param t the value on the curve [0-1] \returns quaternion of the rotation */
     49  /** @param t the value on the curve [0-1] @returns quaternion of the rotation */
    5050  virtual Quaternion calcQuat(float t) = 0;
    5151

  • orxonox/trunk/src/lib/math/vector.cc

    r4746 r4836  
    2828/////////////
    2929/**
    30    \brief returns the this-vector normalized to length 1.0
     30 * returns the this-vector normalized to length 1.0
    3131*/
    3232Vector Vector::getNormalized() const
    … …  
    4646
    4747/**
    48    \brief Vector is looking in the positive direction on all axes after this
     48 * Vector is looking in the positive direction on all axes after this
    4949*/
    5050Vector Vector::abs()
    … …  
    5757
    5858/**
    59    \brief Outputs the values of the Vector
     59 * Outputs the values of the Vector
    6060*/
    6161void Vector::debug() const
    … …  
    7171/////////////////
    7272/**
    73    \brief calculates a lookAt rotation
    74    \param dir: the direction you want to look
    75    \param up: specify what direction up should be
     73 * calculates a lookAt rotation
     74 * @param dir: the direction you want to look
     75 * @param up: specify what direction up should be
    7676
    7777   Mathematically this determines the rotation a (0,0,1)-Vector has to undergo to point
    … …  
    112112
    113113/**
    114    \brief calculates a rotation from euler angles
    115    \param roll: the roll in radians
    116    \param pitch: the pitch in radians
    117    \param yaw: the yaw in radians
     114 * calculates a rotation from euler angles
     115 * @param roll: the roll in radians
     116 * @param pitch: the pitch in radians
     117 * @param yaw: the yaw in radians
    118118*/
    119119Quaternion::Quaternion (float roll, float pitch, float yaw)
    … …  
    140140
    141141/**
    142    \brief rotates one Quaternion by another
    143    \param q: another Quaternion to rotate this by
    144    \return a quaternion that represents the first one rotated by the second one (WARUNING: this operation is not commutative! e.g. (A*B) != (B*A))
     142 * rotates one Quaternion by another
     143 * @param q: another Quaternion to rotate this by
     144 * @return a quaternion that represents the first one rotated by the second one (WARUNING: this operation is not commutative! e.g. (A*B) != (B*A))
    145145*/
    146146Quaternion Quaternion::operator*(const Quaternion& q) const
    … …  
    167167
    168168/**
    169    \brief rotate a Vector by a Quaternion
    170    \param v: the Vector
    171    \return a new Vector representing v rotated by the Quaternion
     169 * rotate a Vector by a Quaternion
     170 * @param v: the Vector
     171 * @return a new Vector representing v rotated by the Quaternion
    172172*/
    173173
    … …  
    183183
    184184/**
    185    \brief multiply a Quaternion with a real value
    186    \param f: a real value
    187    \return a new Quaternion containing the product
     185 * multiply a Quaternion with a real value
     186 * @param f: a real value
     187 * @return a new Quaternion containing the product
    188188*/
    189189Quaternion Quaternion::operator*(const float& f) const
    … …  
    196196
    197197/**
    198    \brief divide a Quaternion by a real value
    199    \param f: a real value
    200    \return a new Quaternion containing the quotient
     198 * divide a Quaternion by a real value
     199 * @param f: a real value
     200 * @return a new Quaternion containing the quotient
    201201*/
    202202Quaternion Quaternion::operator/(const float& f) const
    … …  
    210210
    211211/**
    212    \brief calculate the conjugate value of the Quaternion
    213    \return the conjugate Quaternion
     212 * calculate the conjugate value of the Quaternion
     213 * @return the conjugate Quaternion
    214214*/
    215215/*
    … …  
    223223
    224224/**
    225    \brief calculate the norm of the Quaternion
    226    \return the norm of The Quaternion
     225 * calculate the norm of the Quaternion
     226 * @return the norm of The Quaternion
    227227*/
    228228float Quaternion::norm() const
    … …  
    232232
    233233/**
    234    \brief calculate the inverse value of the Quaternion
    235    \return the inverse Quaternion
     234 * calculate the inverse value of the Quaternion
     235 * @return the inverse Quaternion
    236236
    237237        Note that this is equal to conjugate() if the Quaternion's norm is 1
    … …  
    248248
    249249/**
    250    \brief convert the Quaternion to a 4x4 rotational glMatrix
    251    \param m: a buffer to store the Matrix in
     250 * convert the Quaternion to a 4x4 rotational glMatrix
     251 * @param m: a buffer to store the Matrix in
    252252*/
    253253void Quaternion::matrix (float m[4][4]) const
    … …  
    277277
    278278/**
    279    \brief performs a smooth move.
    280    \param from  where
    281    \param to where
    282    \param t the time this transformation should take value [0..1]
    283 
    284    \returns the Result of the smooth move
     279 * performs a smooth move.
     280 * @param from  where
     281 * @param to where
     282 * @param t the time this transformation should take value [0..1]
     283
     284 * @returns the Result of the smooth move
    285285*/
    286286Quaternion quatSlerp(const Quaternion& from, const Quaternion& to, float t)
    … …  
    339339
    340340/**
    341    \brief convert a rotational 4x4 glMatrix into a Quaternion
    342    \param m: a 4x4 matrix in glMatrix order
     341 * convert a rotational 4x4 glMatrix into a Quaternion
     342 * @param m: a 4x4 matrix in glMatrix order
    343343*/
    344344Quaternion::Quaternion (float m[4][4])
    … …  
    389389
    390390/**
    391    \brief outputs some nice formated debug information about this quaternion
     391 * outputs some nice formated debug information about this quaternion
    392392*/
    393393void Quaternion::debug()
    … …  
    398398
    399399/**
    400    \brief create a rotation from a vector
    401    \param v: a vector
     400 * create a rotation from a vector
     401 * @param v: a vector
    402402*/
    403403Rotation::Rotation (const Vector& v)
    … …  
    421421
    422422/**
    423    \brief creates a rotation from an axis and an angle (radians!)
    424    \param axis: the rotational axis
    425    \param angle: the angle in radians
     423 * creates a rotation from an axis and an angle (radians!)
     424 * @param axis: the rotational axis
     425 * @param angle: the angle in radians
    426426*/
    427427Rotation::Rotation (const Vector& axis, float angle)
    … …  
    442442
    443443/**
    444    \brief creates a rotation from euler angles (pitch/yaw/roll)
    445    \param pitch: rotation around z (in radians)
    446    \param yaw: rotation around y (in radians)
    447    \param roll: rotation around x (in radians)
     444 * creates a rotation from euler angles (pitch/yaw/roll)
     445 * @param pitch: rotation around z (in radians)
     446 * @param yaw: rotation around y (in radians)
     447 * @param roll: rotation around x (in radians)
    448448*/
    449449Rotation::Rotation ( float pitch, float yaw, float roll)
    … …  
    468468
    469469/**
    470    \brief creates a nullrotation (an identity rotation)
     470 * creates a nullrotation (an identity rotation)
    471471*/
    472472Rotation::Rotation ()
    … …  
    484484
    485485/**
    486    \brief fills the specified buffer with a 4x4 glmatrix
    487    \param buffer: Pointer to an array of 16 floats
     486 * fills the specified buffer with a 4x4 glmatrix
     487 * @param buffer: Pointer to an array of 16 floats
    488488
    489489   Use this to get the rotation in a gl-compatible format
    … …  
    510510
    511511/**
    512    \brief multiplies two rotational matrices
    513    \param r: another Rotation
    514    \return the matrix product of the Rotations
     512 * multiplies two rotational matrices
     513 * @param r: another Rotation
     514 * @return the matrix product of the Rotations
    515515
    516516   Use this to rotate one rotation by another
    … …  
    537537
    538538/**
    539    \brief rotates the vector by the given rotation
    540    \param v: a vector
    541    \param r: a rotation
    542    \return the rotated vector
     539 * rotates the vector by the given rotation
     540 * @param v: a vector
     541 * @param r: a rotation
     542 * @return the rotated vector
    543543*/
    544544Vector rotateVector( const Vector& v, const Rotation& r)
    … …  
    554554
    555555/**
    556    \brief calculate the distance between two lines
    557    \param l: the other line
    558    \return the distance between the lines
     556 * calculate the distance between two lines
     557 * @param l: the other line
     558 * @return the distance between the lines
    559559*/
    560560float Line::distance (const Line& l) const
    … …  
    569569
    570570/**
    571    \brief calculate the distance between a line and a point
    572    \param v: the point
    573    \return the distance between the Line and the point
     571 * calculate the distance between a line and a point
     572 * @param v: the point
     573 * @return the distance between the Line and the point
    574574*/
    575575float Line::distancePoint (const Vector& v) const
    … …  
    581581
    582582/**
    583    \brief calculate the distance between a line and a point
    584    \param v: the point
    585    \return the distance between the Line and the point
     583 * calculate the distance between a line and a point
     584 * @param v: the point
     585 * @return the distance between the Line and the point
    586586 */
    587587float Line::distancePoint (const sVec3D& v) const
    … …  
    594594
    595595/**
    596    \brief calculate the two points of minimal distance of two lines
    597    \param l: the other line
    598    \return a Vector[2] (!has to be deleted after use!) containing the two points of minimal distance
     596 * calculate the two points of minimal distance of two lines
     597 * @param l: the other line
     598 * @return a Vector[2] (!has to be deleted after use!) containing the two points of minimal distance
    599599*/
    600600Vector* Line::footpoints (const Line& l) const
    … …  
    618618
    619619/**
    620    \brief rotate the line by given rotation
    621    \param rot: a rotation
     620 * rotate the line by given rotation
     621 * @param rot: a rotation
    622622*/
    623623void Line::rotate (const Rotation& rot)
    … …  
    630630
    631631/**
    632    \brief create a plane from three points
    633    \param a: first point
    634    \param b: second point
    635    \param c: third point
     632 * create a plane from three points
     633 * @param a: first point
     634 * @param b: second point
     635 * @param c: third point
    636636*/
    637637Plane::Plane (Vector a, Vector b, Vector c)
    … …  
    642642
    643643/**
    644    \brief create a plane from anchor point and normal
    645    \param norm: normal vector
    646    \param p: anchor point
     644 * create a plane from anchor point and normal
     645 * @param norm: normal vector
     646 * @param p: anchor point
    647647*/
    648648Plane::Plane (Vector norm, Vector p)
    … …  
    654654
    655655/**
    656     \brief create a plane from anchor point and normal
    657     \param norm: normal vector
    658     \param p: anchor point
     656  * create a plane from anchor point and normal
     657  * @param norm: normal vector
     658  * @param p: anchor point
    659659*/
    660660Plane::Plane (Vector norm, sVec3D g)
    … …  
    667667
    668668/**
    669    \brief returns the intersection point between the plane and a line
    670    \param l: a line
     669 * returns the intersection point between the plane and a line
     670 * @param l: a line
    671671*/
    672672Vector Plane::intersectLine (const Line& l) const
    … …  
    678678
    679679/**
    680    \brief returns the distance between the plane and a point
    681    \param p: a Point
    682    \return the distance between the plane and the point (can be negative)
     680 * returns the distance between the plane and a point
     681 * @param p: a Point
     682 * @return the distance between the plane and the point (can be negative)
    683683*/
    684684float Plane::distancePoint (const Vector& p) const
    … …  
    691691
    692692/**
    693    \brief returns the distance between the plane and a point
    694    \param p: a Point
    695    \return the distance between the plane and the point (can be negative)
     693 * returns the distance between the plane and a point
     694 * @param p: a Point
     695 * @return the distance between the plane and the point (can be negative)
    696696 */
    697697float Plane::distancePoint (const sVec3D& p) const
    … …  
    705705
    706706/**
    707    \brief returns the side a point is located relative to a Plane
    708    \param p: a Point
    709    \return 0 if the point is contained within the Plane, positive(negative) if the point is in the positive(negative) semi-space of the Plane
     707 * returns the side a point is located relative to a Plane
     708 * @param p: a Point
     709 * @return 0 if the point is contained within the Plane, positive(negative) if the point is in the positive(negative) semi-space of the Plane
    710710*/
    711711float Plane::locatePoint (const Vector& p) const

  • orxonox/trunk/src/lib/math/vector.h

    r4611 r4836  
    11/*!
    22    \file vector.h
    3     \brief A basic 3D math framework
     3  * A basic 3D math framework
    44
    55    Contains classes to handle vectors, lines, rotations and planes
    … …  
    2727  ~Vector () {}
    2828
    29   /** \param index The index of the "array" \returns the x/y/z coordinate */
     29  /** @param index The index of the "array" @returns the x/y/z coordinate */
    3030  inline float operator[] (float index) const {if( index == 0) return this->x; if( index == 1) return this->y; if( index == 2) return this->z; }
    31   /**  \param v The vector to add \returns the addition between two vectors (this + v) */
     31  /*** @param v The vector to add @returns the addition between two vectors (this + v) */
    3232  inline Vector operator+ (const Vector& v) const { return Vector(x + v.x, y + v.y, z + v.z); };
    33   /**  \param v The vector to add \returns the addition between two vectors (this + v) */
     33  /*** @param v The vector to add @returns the addition between two vectors (this + v) */
    3434  inline Vector operator+ (const sVec3D& v) const { return Vector(x + v[0], y + v[1], z + v[2]); };
    35   /** \param v The vector to add  \returns the addition between two vectors (this += v) */
     35  /** @param v The vector to add  @returns the addition between two vectors (this += v) */
    3636  inline const Vector& operator+= (const Vector& v) { this->x += v.x; this->y += v.y; this->z += v.z; return *this; };
    37   /** \param v The vector to substract  \returns the substraction between two vectors (this - v) */
     37  /** @param v The vector to substract  @returns the substraction between two vectors (this - v) */
    3838  inline const Vector& operator+= (const sVec3D& v) { this->x += v[0]; this->y += v[1]; this->z += v[2]; return *this; };
    39   /** \param v The vector to substract  \returns the substraction between two vectors (this - v) */
     39  /** @param v The vector to substract  @returns the substraction between two vectors (this - v) */
    4040  inline Vector operator- (const Vector& v) const { return Vector(x - v.x, y - v.y, z - v.z); }
    41   /** \param v The vector to substract  \returns the substraction between two vectors (this - v) */
     41  /** @param v The vector to substract  @returns the substraction between two vectors (this - v) */
    4242  inline Vector operator- (const sVec3D& v) const { return Vector(x - v[0], y - v[1], z - v[2]); }
    43   /** \param v The vector to substract  \returns the substraction between two vectors (this -= v) */
     43  /** @param v The vector to substract  @returns the substraction between two vectors (this -= v) */
    4444  inline const Vector& operator-= (const Vector& v) { this->x -= v.x; this->y -= v.y; this->z -= v.z; return *this; };
    45   /** \param v The vector to substract  \returns the substraction between two vectors (this -= v) */
     45  /** @param v The vector to substract  @returns the substraction between two vectors (this -= v) */
    4646  inline const Vector& operator-= (const sVec3D& v) { this->x -= v[0]; this->y -= v[1]; this->z -= v[2]; return *this; };
    47   /** \param v the second vector  \returns The dotProduct between two vector (this (dot) v) */
     47  /** @param v the second vector  @returns The dotProduct between two vector (this (dot) v) */
    4848  inline float operator* (const Vector& v) const { return x * v.x + y * v.y + z * v.z; };
    49   /** \todo strange */
     49  /** @todo strange */
    5050  inline const Vector& operator*= (const Vector& v) { this->x *= v.x; this->y *= v.y; this->z *= v.z; return *this; };
    51   /** \param f a factor to multiply the vector with \returns the vector multiplied by f (this * f) */
     51  /** @param f a factor to multiply the vector with @returns the vector multiplied by f (this * f) */
    5252  inline Vector operator* (float f) const { return Vector(x * f, y * f, z * f); };
    53   /** \param f a factor to multiply the vector with \returns the vector multiplied by f (this *= f) */
     53  /** @param f a factor to multiply the vector with @returns the vector multiplied by f (this *= f) */
    5454  inline const Vector& operator*= (float f) { this->x *= f; this->y *= f; this->z *= f; return *this; };
    55   /** \param f a factor to divide the vector with \returns the vector divided by f (this / f) */
     55  /** @param f a factor to divide the vector with @returns the vector divided by f (this / f) */
    5656  inline Vector operator/ (float f) const {if (unlikely(f == 0.0)) return Vector(0,0,0); else return Vector(this->x / f, this->y / f, this->z / f); };
    57   /** \param f a factor to divide the vector with \returns the vector divided by f (this /= f) */
     57  /** @param f a factor to divide the vector with @returns the vector divided by f (this /= f) */
    5858  inline const Vector& operator/= (float f) {if (unlikely(f == 0.0)) {this->x=0;this->y=0;this->z=0;} else {this->x /= f; this->y /= f; this->z /= f;} return *this; };
    59   /** \brief copy constructor \todo (i do not know it this is faster) \param v the vector to assign to this vector. \returns the vector v */
     59  /** \brief copy constructor @todo (i do not know it this is faster) @param v the vector to assign to this vector. @returns the vector v */
    6060  inline const Vector& operator= (const Vector& v) { this->x = v.x; this->y = v.y; this->z = v.z; return *this; };
    61   /** \brief copy constructor  \param v the sVec3D to assign to this vector. \returns the vector v */
     61  /** \brief copy constructor* @param v the sVec3D to assign to this vector. @returns the vector v */
    6262  inline const Vector& operator= (const sVec3D& v) { this->x = v[0]; this->y = v[1]; this->z = v[2]; }
    63   /** \param v: the other vector \return the dot product of the vectors */
     63  /** @param v: the other vector \return the dot product of the vectors */
    6464  float dot (const Vector& v) const { return x*v.x+y*v.y+z*v.z; };
    65   /** \param v: the corss-product partner \returns the cross-product between this and v (this (x) v) */
     65  /** @param v: the corss-product partner @returns the cross-product between this and v (this (x) v) */
    6666  inline Vector cross (const Vector& v) const { return Vector(y * v.z - z * v.y, z * v.x - x * v.z, x * v.y - y * v.x ); }
    67   /** \brief scales the this vector with v  \param v the vector to scale this with */
     67  /** \brief scales the this vector with v* @param v the vector to scale this with */
    6868  void scale(const Vector& v) {   x *= v.x;  y *= v.y; z *= v.z; };
    69   /** \returns the length of the vector */
     69  /** @returns the length of the vector */
    7070  inline float len() const { return sqrt (x*x+y*y+z*z); }
    7171  /** \brief normalizes the vector */
    … …  
    9393
    9494/**
    95    \brief calculate the angle between two vectors in radiances
    96    \param v1: a vector
    97    \param v2: another vector
    98    \return the angle between the vectors in radians
     95 * calculate the angle between two vectors in radiances
     96 * @param v1: a vector
     97 * @param v2: another vector
     98 * @return the angle between the vectors in radians
    9999*/
    100100inline float angleDeg (const Vector& v1, const Vector& v2) { return acos( v1 * v2 / (v1.len() * v2.len())); };
    101101/**
    102    \brief calculate the angle between two vectors in degrees
    103    \param v1: a vector
    104    \param v2: another vector
    105    \return the angle between the vectors in degrees
     102 * calculate the angle between two vectors in degrees
     103 * @param v1: a vector
     104 * @param v2: another vector
     105 * @return the angle between the vectors in degrees
    106106*/
    107107inline float angleRad (const Vector& v1, const Vector& v2) { return acos( v1 * v2 / (v1.len() * v2.len())) * 180/M_PI; };
    … …  
    117117  /** \brief creates a Default quaternion (multiplicational identity Quaternion)*/
    118118  inline Quaternion () { w = 1; v = Vector(0,0,0); }
    119   /** \brief creates a Quaternion looking into the direction v \param v: the direction \param f: the value */
     119  /** \brief creates a Quaternion looking into the direction v @param v: the direction @param f: the value */
    120120  inline Quaternion (const Vector& v, float f) { this->w = f; this->v = v; }
    121121  Quaternion (float m[4][4]);
    122   /** \brief turns a rotation along an axis into a Quaternion \param angle: the amount of radians to rotate \param axis: the axis to rotate around */
     122  /** \brief turns a rotation along an axis into a Quaternion @param angle: the amount of radians to rotate @param axis: the axis to rotate around */
    123123  inline Quaternion (float angle, const Vector& axis) { w = cos(angle/2); v = axis * sin(angle/2); }
    124124  Quaternion (const Vector& dir, const Vector& up);
    125125  Quaternion (float roll, float pitch, float yaw);
    126126  Quaternion operator/ (const float& f) const;
    127   /** \param f: the value to divide by \returns the quaternion devided by f (this /= f) */
     127  /** @param f: the value to divide by @returns the quaternion devided by f (this /= f) */
    128128  inline const Quaternion& operator/= (const float& f) {*this = *this / f; return *this;}
    129129  Quaternion operator* (const float& f) const;
    130   /** \param f: the value to multiply by \returns the quaternion multiplied by f (this *= f) */
     130  /** @param f: the value to multiply by @returns the quaternion multiplied by f (this *= f) */
    131131  inline const Quaternion& operator*= (const float& f) {*this = *this * f; return *this;}
    132132  Quaternion operator* (const Quaternion& q) const;
    133   /** \param q: the Quaternion to multiply by \returns the quaternion multiplied by q (this *= q) */
     133  /** @param q: the Quaternion to multiply by @returns the quaternion multiplied by q (this *= q) */
    134134  inline const Quaternion operator*= (const Quaternion& q) {*this = *this * q; return *this; };
    135   /** \param q the Quaternion to add to this \returns the quaternion added with q (this + q) */
     135  /** @param q the Quaternion to add to this @returns the quaternion added with q (this + q) */
    136136  inline Quaternion operator+ (const Quaternion& q) const { return Quaternion(q.v + v, q.w + w); };
    137   /** \param q the Quaternion to add to this \returns the quaternion added with q (this += q) */
     137  /** @param q the Quaternion to add to this @returns the quaternion added with q (this += q) */
    138138  inline const Quaternion& operator+= (const Quaternion& q) { this->v += q.v; this->w += q.w; return *this; };
    139   /** \param q the Quaternion to substrace from this \returns the quaternion substracted by q (this - q) */
     139  /** @param q the Quaternion to substrace from this @returns the quaternion substracted by q (this - q) */
    140140  inline Quaternion operator- (const Quaternion& q) const { return Quaternion(q.v - v, q.w - w); }
    141   /** \param q the Quaternion to substrace from this \returns the quaternion substracted by q (this -= q) */
     141  /** @param q the Quaternion to substrace from this @returns the quaternion substracted by q (this -= q) */
    142142  inline const Quaternion& operator-= (const Quaternion& q) { this->v -= q.v; this->w -= q.w; return *this; };
    143   /** \brief copy constructor \param q: the Quaternion to set this to. \returns the Quaternion q (or this) */
     143  /** \brief copy constructor @param q: the Quaternion to set this to. @returns the Quaternion q (or this) */
    144144  inline Quaternion operator= (const Quaternion& q) {this->v = q.v; this->w = q.w; return *this;}
    145   /** \brief conjugates this Quaternion \returns the conjugate */
     145  /** \brief conjugates this Quaternion @returns the conjugate */
    146146  inline Quaternion conjugate () const {  Quaternion r(*this);  r.v = Vector() - r.v;  return r;}
    147147  Quaternion inverse () const;

  • orxonox/trunk/src/lib/particles/particle_emitter.cc

    r4746 r4836  
    3131
    3232/**
    33    \brief standard constructor
     33 * standard constructor
    3434*/
    3535ParticleEmitter::ParticleEmitter(const Vector& direction, float angle, float emissionRate,
    … …  
    4747
    4848/**
    49    \brief constructs and loads a ParticleEmitter from a XML-element
    50    \param root the XML-element to load from
     49 * constructs and loads a ParticleEmitter from a XML-element
     50 * @param root the XML-element to load from
    5151*/
    5252ParticleEmitter::ParticleEmitter(const TiXmlElement* root)
    … …  
    6161
    6262/**
    63    \brief standard destructor
     63 * standard destructor
    6464
    6565   removes the EmitterSystem from the ParticleEngine
    … …  
    8787
    8888/**
    89    \brief loads a ParticleEmitter from a XML-element
    90    \param root the XML-element to load from
     89 * loads a ParticleEmitter from a XML-element
     90 * @param root the XML-element to load from
    9191*/
    9292void ParticleEmitter::loadParams(const TiXmlElement* root)
    … …  
    120120
    121121/**
    122    \brief this start the emitter
     122 * this start the emitter
    123123*/
    124124void ParticleEmitter::start() {}
    … …  
    126126
    127127/**
    128    \brief this stops the emitter
     128 * this stops the emitter
    129129*/
    130130void ParticleEmitter::stop() {}
    … …  
    135135
    136136/**
    137    \param type the new Type of this emitter
     137 * @param type the new Type of this emitter
    138138*/
    139139void ParticleEmitter::setType(EMITTER_TYPE type)
    … …  
    143143
    144144/**
    145    \brief sets the type of emitter
    146    \param type the type as a const char*
     145 * sets the type of emitter
     146 * @param type the type as a const char*
    147147   dot: EMITTER_DOT, plane: EMITTER_PLANE, cube: EMITTER_CUBE, sphere, EMITTER_SPHERE;
    148148*/
    … …  
    172172
    173173/**
    174    \brief sets a new size to the emitter
     174 * sets a new size to the emitter
    175175*/
    176176void ParticleEmitter::setSize(float emitterSize)
    … …  
    183183
    184184/**
    185    \brief set the emission rate
    186    \param emissionRate: sets the number of particles emitted per second
     185 * set the emission rate
     186 * @param emissionRate: sets the number of particles emitted per second
    187187
    188188   if you want to change the value of this variable during emission time (to make it more dynamic)
    … …  
    198198
    199199/**
    200    \brief how much of the speed from the ParticleEmitter should flow onto the ParticleSystem
    201    \param value a Value between zero and one
     200 * how much of the speed from the ParticleEmitter should flow onto the ParticleSystem
     201 * @param value a Value between zero and one
    202202
    203203   if you want to change the value of this variable during emission time (to make it more dynamic)
    … …  
    215215
    216216/**
    217    \brief set the angle of the emitter
    218    \param angle around the direction in which there are particles to be emitted
    219    \param randomAngle A random spread-angle, the +- randomness of this option
     217 * set the angle of the emitter
     218 * @param angle around the direction in which there are particles to be emitted
     219 * @param randomAngle A random spread-angle, the +- randomness of this option
    220220
    221221   if you want to change the value of this variable during emission time (to make it more dynamic)
    … …  
    229229
    230230/**
    231    \brief sets the initial velocity of all particles emitted
    232    \param velocity The starting velocity of the emitted particles
    233    \param randomVelocity A random starting velocity, the +- randomness of this option
     231 * sets the initial velocity of all particles emitted
     232 * @param velocity The starting velocity of the emitted particles
     233 * @param randomVelocity A random starting velocity, the +- randomness of this option
    234234
    235235   if you want to change the value of this variable during emission time (to make it more dynamic)
    … …  
    243243
    244244/**
    245    \brief sets the initial Momentum of all particles emitted
    246    \param momentum the new Momentum (just a float for being not too complicated).
    247    \param randomMomentum variation from the given value.
     245 * sets the initial Momentum of all particles emitted
     246 * @param momentum the new Momentum (just a float for being not too complicated).
     247 * @param randomMomentum variation from the given value.
    248248 */
    249249void ParticleEmitter::setEmissionMomentum(float momentum, float randomMomentum)
    … …  
    254254
    255255/**
    256    \brief this set the time to life of a particle, after which it will die
    257    \param dt: the time to live in seconds
    258    \param system: the system into which to emitt
     256 * this set the time to life of a particle, after which it will die
     257 * @param dt: the time to live in seconds
     258 * @param system: the system into which to emitt
    259259
    260260   if you want to change the value of this variable during emission time (to make it more dynamic)
    … …  
    308308
    309309/**
    310    \brief outputs some nice debug information
     310 * outputs some nice debug information
    311311*/
    312312void ParticleEmitter::debug() const

  • orxonox/trunk/src/lib/particles/particle_emitter.h

    r4746 r4836  
    11/*!
    22    \file particle_emitter.h
    3     \brief Definition of a ParticleEmitter
     3  * Definition of a ParticleEmitter
    44*/
    55
    … …  
    5858  void setDirection(float x, float y, float z) { this->direction = Vector(x,y,z); }; //!< todo this should be done via PNODE
    5959
    60   /** \returns the type of the emitter */
     60  /** @returns the type of the emitter */
    6161  inline EMITTER_TYPE getType() const { return this->type; };
    62   /** \returns the Type as a const char * */
     62  /** @returns the Type as a const char * */
    6363  const char* getTypeC() const;
    64   /** \returns the Size of the emitter */
     64  /** @returns the Size of the emitter */
    6565  inline float getSize() const { return this->emitterSize; };
    66   /** \returns the emissionRate */
     66  /** @returns the emissionRate */
    6767  inline float getEmissionRate() const { return this->emissionRate; };
    68   /** \returns the inherit-speed-factor */
     68  /** @returns the inherit-speed-factor */
    6969  inline float getInheritSpeed() const { return this->inheritSpeed; };
    70   /** \returns the SpreadAngle of the emitter */
     70  /** @returns the SpreadAngle of the emitter */
    7171  inline float getSpread() const { return this->angle; };
    72   /** \returns the EmissionVelocity of the emitter */
     72  /** @returns the EmissionVelocity of the emitter */
    7373  inline float getEmissionVelocity() const { return this->velocity; };
    74   /** \returns the EmissionMomentum of this emitter */
     74  /** @returns the EmissionMomentum of this emitter */
    7575  inline float getEmissionMomentum() const { return this->momentum; };
    7676

  • orxonox/trunk/src/lib/particles/particle_engine.cc

    r4834 r4836  
    2929
    3030/**
    31    \brief standard constructor
     31 * standard constructor
    3232*/
    3333ParticleEngine::ParticleEngine ()
    … …  
    4242
    4343/**
    44    \brief the singleton reference to this class
     44 * the singleton reference to this class
    4545*/
    4646ParticleEngine* ParticleEngine::singletonRef = NULL;
    4747
    4848/**
    49    \brief deletes all the system, emitters, connections and Lists
     49 * deletes all the system, emitters, connections and Lists
    5050*/
    5151ParticleEngine::~ParticleEngine ()
    … …  
    8484/**
    8585  \brief loads the ParticleEngines settings and connections between particles and emitters
    86   \param root the XML-element to load this from.
     86* @param root the XML-element to load this from.
    8787 */
    8888void ParticleEngine::loadParams(const TiXmlElement* root)
    … …  
    9898
    9999/**
    100    \brief Adds a System to the System list.
     100 * Adds a System to the System list.
    101101
    102102   this is done automatically when creating a ParticleSystem
    … …  
    108108
    109109/**
    110    \brief Adds an emitter to the emitterList
     110 * Adds an emitter to the emitterList
    111111
    112112   this is done automatically when creating a ParticleEmitter
    … …  
    119119/**
    120120  \brief Connects a ParticleSystem to a ParticleSystem thus emitting Particles.
    121   \param emitter the Emitter to connect to the System
    122   \param system the System to connect to the Emitter
     121* @param emitter the Emitter to connect to the System
     122* @param system the System to connect to the Emitter
    123123*/
    124124void ParticleEngine::addConnection(const char* emitter, const char* system)
    … …  
    139139
    140140/**
    141    \brief Connects a ParticleSystem to a ParticleSystem thus emitting Particles.
    142    \param emitter the Emitter to connect to the System
    143    \param system the System to connect to the Emitter
     141 * Connects a ParticleSystem to a ParticleSystem thus emitting Particles.
     142 * @param emitter the Emitter to connect to the System
     143 * @param system the System to connect to the Emitter
    144144*/
    145145void ParticleEngine::addConnection(ParticleEmitter* emitter, ParticleSystem* system)
    … …  
    171171
    172172/**
    173    \brief Removes a system from the systemList and also removes all Connections to the System
    174    \param system The ParticleSystem to delete
     173 * Removes a system from the systemList and also removes all Connections to the System
     174 * @param system The ParticleSystem to delete
    175175*/
    176176bool ParticleEngine::removeSystem(ParticleSystem* system)
    … …  
    192192
    193193/**
    194    \brief removes an emitter from the emitterList and also from all Connections it is attached to.
    195    \param emitter the ParticleEmitter to remove.
     194 * removes an emitter from the emitterList and also from all Connections it is attached to.
     195 * @param emitter the ParticleEmitter to remove.
    196196*/
    197197bool ParticleEngine::removeEmitter(ParticleEmitter* emitter)
    … …  
    213213
    214214/**
    215    \brief removes a Connection between an Emitter and a System
    216    \param emitter The emitter of the connection to remove
    217    \param system The system of the connection to remove
    218    \returns true, if the connection was broken, false if the conntection was not found
     215 * removes a Connection between an Emitter and a System
     216 * @param emitter The emitter of the connection to remove
     217 * @param system The system of the connection to remove
     218 * @returns true, if the connection was broken, false if the conntection was not found
    219219
    220220   only if both system and emitter are in the connection the Connection will be broken
    … …  
    240240
    241241/**
    242    \brief removes a Connection between an Emitter and a System
    243    \param connection the connection to remove
     242 * removes a Connection between an Emitter and a System
     243 * @param connection the connection to remove
    244244
    245245   \see bool ParticleEngine::breakConnection(ParticleEmitter* emitter, ParticleSystem* system)
    … …  
    253253
    254254/**
    255    \brief this function ticks all the ParticleSystems, so an animation will flow
    256    \param dt passed since last tick
     255 * this function ticks all the ParticleSystems, so an animation will flow
     256 * @param dt passed since last tick
    257257*/
    258258void ParticleEngine::tick(float dt)
    … …  
    280280
    281281/**
    282    \brief draws all the systems and their Particles.
     282 * draws all the systems and their Particles.
    283283*/
    284284void ParticleEngine::draw() const
    … …  
    296296
    297297/**
    298    \param systemName the name of the system to search for
    299    \returns the system called by systemName or NULL if not found
     298 * @param systemName the name of the system to search for
     299 * @returns the system called by systemName or NULL if not found
    300300*/
    301301ParticleSystem* ParticleEngine::getSystemByName(const char* systemName) const
    … …  
    317317
    318318/**
    319    \param number the n-th system to return
    320    \returns the system called by number or NULL if not found
     319 * @param number the n-th system to return
     320 * @returns the system called by number or NULL if not found
    321321*/
    322322ParticleSystem* ParticleEngine::getSystemByNumber(unsigned int number) const
    … …  
    340340
    341341/**
    342    \param emitterName the name of the emitter to search for
    343    \returns the emitter called by emitterName or NULL if not found
     342 * @param emitterName the name of the emitter to search for
     343 * @returns the emitter called by emitterName or NULL if not found
    344344*/
    345345ParticleEmitter* ParticleEngine::getEmitterByName(const char* emitterName) const
    … …  
    362362
    363363/**
    364    \param number the n-th emitter to return
    365    \returns the emitter called by number or NULL if not found
     364 * @param number the n-th emitter to return
     365 * @returns the emitter called by number or NULL if not found
    366366*/
    367367ParticleEmitter* ParticleEngine::getEmitterByNumber(unsigned int number) const
    … …  
    385385
    386386/**
    387    \brief outputs some nice debug information
     387 * outputs some nice debug information
    388388*/
    389389void ParticleEngine::debug()

  • orxonox/trunk/src/lib/particles/particle_engine.h

    r4746 r4836  
    11/*!
    22    \file particle_engine.h
    3     \brief Definition of the ParticleEngine
     3  * Definition of the ParticleEngine
    44*/
    55
    … …  
    3434 public:
    3535  virtual ~ParticleEngine();
    36   /** \returns a Pointer to the only object of this Class */
     36  /** @returns a Pointer to the only object of this Class */
    3737  inline static ParticleEngine* getInstance() { if (!singletonRef) singletonRef = new ParticleEngine();  return singletonRef; };
    3838

  • orxonox/trunk/src/lib/particles/particle_system.cc

    r4827 r4836  
    3535
    3636/**
    37    \brief standard constructor
    38    \param maxCount the Count of particles in the System
    39    \param type The Type of the ParticleSystem
     37 * standard constructor
     38 * @param maxCount the Count of particles in the System
     39 * @param type The Type of the ParticleSystem
    4040*/
    4141ParticleSystem::ParticleSystem (unsigned int maxCount, PARTICLE_TYPE type)
    … …  
    4949/**
    5050  \brief creates a Particle System out of a XML-element
    51   \param root: the XML-element to load from
     51* @param root: the XML-element to load from
    5252 */
    5353ParticleSystem::ParticleSystem(const TiXmlElement* root)
    … …  
    5959
    6060/**
    61    \brief standard deconstructor
     61 * standard deconstructor
    6262*/
    6363ParticleSystem::~ParticleSystem()
    … …  
    147147
    148148/**
    149   \param maxCount the maximum count of particles that can be emitted
     149* @param maxCount the maximum count of particles that can be emitted
    150150 */
    151151void ParticleSystem::setMaxCount(int maxCount)
    … …  
    156156
    157157/**
    158    \param particleType the type of particles in this System
    159    \param count how many particles (in PARTICLE_MULTI-mode)
    160    \todo this will be different
     158 * @param particleType the type of particles in this System
     159 * @param count how many particles (in PARTICLE_MULTI-mode)
     160   @todo this will be different
    161161*/
    162162void ParticleSystem::setType(const char* particleType)
    … …  
    173173
    174174/**
    175    \param particleType the type of particles in this System
    176    \param count how many particles (in PARTICLE_MULTI-mode)
    177    \todo this will be different
     175 * @param particleType the type of particles in this System
     176 * @param count how many particles (in PARTICLE_MULTI-mode)
     177   @todo this will be different
    178178*/
    179179void ParticleSystem::setType(PARTICLE_TYPE particleType, int count)
    … …  
    205205// setting properties
    206206/**
    207    \brief sets the material to an external material
    208    \param material: the material to set this material to.
     207 * sets the material to an external material
     208 * @param material: the material to set this material to.
    209209
    210210   !! important if the extern material gets deleted it MUST be unregistered here or segfault !!
    … …  
    216216
    217217/**
    218    \brief Sets the lifespan of newly created particles
     218 * Sets the lifespan of newly created particles
    219219*/
    220220void ParticleSystem::setLifeSpan(float lifeSpan, float randomLifeSpan)
    … …  
    225225
    226226/**
    227    \brief sets the conserve Factor of newly created particles
     227 * sets the conserve Factor of newly created particles
    228228*/
    229229void ParticleSystem::setConserve(float conserve)
    … …  
    241241/////////////////////////////
    242242/**
    243    \brief sets a key in the radius-animation on a per-particle basis
    244    \param lifeCycleTime the time (partilceLifeTime/particleAge) [0-1]
    245    \param radius the radius at this position
    246    \param randRadius the randRadius at this position
     243 * sets a key in the radius-animation on a per-particle basis
     244 * @param lifeCycleTime the time (partilceLifeTime/particleAge) [0-1]
     245 * @param radius the radius at this position
     246 * @param randRadius the randRadius at this position
    247247*/
    248248void ParticleSystem::setRadius(float lifeCycleTime, float radius, float randRadius)
    … …  
    253253
    254254/**
    255    \brief sets a key in the mass-animation on a per-particle basis
    256    \param lifeCycleTime the time (partilceLifeTime/particleAge) [0-1]
    257    \param mass the mass at this position
    258    \param randMass the randomMass at this position
     255 * sets a key in the mass-animation on a per-particle basis
     256 * @param lifeCycleTime the time (partilceLifeTime/particleAge) [0-1]
     257 * @param mass the mass at this position
     258 * @param randMass the randomMass at this position
    259259*/
    260260void ParticleSystem::setMass(float lifeCycleTime, float mass, float randMass)
    … …  
    265265
    266266/**
    267    \brief sets a key in the color-animation on a per-particle basis
    268    \param lifeCycleTime: the time (partilceLifeTime/particleAge) [0-1]
    269    \param red: red
    270    \param green: green
    271    \param blue: blue
    272    \param alpha: alpha
     267 * sets a key in the color-animation on a per-particle basis
     268 * @param lifeCycleTime: the time (partilceLifeTime/particleAge) [0-1]
     269 * @param red: red
     270 * @param green: green
     271 * @param blue: blue
     272 * @param alpha: alpha
    273273*/
    274274void ParticleSystem::setColor(float lifeCycleTime, float red, float green, float blue, float alpha)
    … …  
    281281
    282282/**
    283    \brief ticks the system.
    284    \param dt the time to tick all the Particles of the System
     283 * ticks the system.
     284 * @param dt the time to tick all the Particles of the System
    285285
    286286   this is used to get all the particles some motion
    … …  
    350350
    351351/**
    352     \brief applies some force to a Particle.
    353     \param field the Field to apply.
     352  * applies some force to a Particle.
     353  * @param field the Field to apply.
    354354 */
    355355void ParticleSystem::applyField(Field* field)
    … …  
    365365
    366366/**
    367  * \returns the count of Faces of this ParticleSystem
     367 * @returns the count of Faces of this ParticleSystem
    368368 */
    369369unsigned int ParticleSystem::getFaceCount() const
    … …  
    383383
    384384/**
    385    \brief draws all the Particles of this System
     385 * draws all the Particles of this System
    386386
    387387   The Cases in this Function all do the same:
    … …  
    410410      {
    411411        glColor4fv(drawPart->color);
    412           //! \todo implement a faster code for the look-at Camera algorithm.
    413 
    414         const PNode* camera = State::getCamera();  //!< \todo MUST be different
     412          //! @todo implement a faster code for the look-at Camera algorithm.
     413
     414        const PNode* camera = State::getCamera();  //!< @todo MUST be different
    415415        Vector cameraPos = camera->getAbsCoor();
    416416        Vector cameraTargetPos = State::getCameraTarget()->getAbsCoor();
    … …  
    515515
    516516/**
    517    \brief adds a new Particle to the System
    518    \param position the initial position, where the particle gets emitted.
    519    \param velocity the initial velocity of the particle.
    520    \param orientation the initial orientation of the Paritcle.
    521    \param momentum the initial momentum of the Particle (the speed of its rotation).
    522    \param data some more data given by the emitter
     517 * adds a new Particle to the System
     518 * @param position the initial position, where the particle gets emitted.
     519 * @param velocity the initial velocity of the particle.
     520 * @param orientation the initial orientation of the Paritcle.
     521 * @param momentum the initial momentum of the Particle (the speed of its rotation).
     522 * @param data some more data given by the emitter
    523523*/
    524524void ParticleSystem::addParticle(const Vector& position, const Vector& velocity, const Quaternion& orientation, const Quaternion& momentum, unsigned int data)
    … …  
    566566      particles->momentum = momentum;
    567567
    568       //  particle->rotation = ; //! \todo rotation is once again something to be done.
     568      //  particle->rotation = ; //! @todo rotation is once again something to be done.
    569569      particles->massRand = 2*(float)rand()/RAND_MAX -1;
    570570      particles->radiusRand = 2* (float)rand()/RAND_MAX -1;
    … …  
    579579
    580580/**
    581    \brief outputs some nice debug information
     581 * outputs some nice debug information
    582582*/
    583583void ParticleSystem::debug() const

  • orxonox/trunk/src/lib/particles/particle_system.h

    r4746 r4836  
    8989  void setColor(float lifeCycleTime, float red, float green, float blue, float alpha);
    9090
    91   /** \returns the Type of the particles */
     91  /** @returns the Type of the particles */
    9292  inline PARTICLE_TYPE getType() const { return this->particleType; };
    93   /** \returns the Material that lies on this particles */
     93  /** @returns the Material that lies on this particles */
    9494  inline const Material* getMaterial() const { return this->material; };
    95   /** \returns the lifespan of the particles */
     95  /** @returns the lifespan of the particles */
    9696  inline float getLifeSpan() const { return this->lifeSpan; };
    97   /** \returns the starting-radius of the particles */
     97  /** @returns the starting-radius of the particles */
    9898  inline float getStartRadius() { return this->radiusAnim.getValue(0.0); };
    99   /** \returns the end-radius of the particles */
     99  /** @returns the end-radius of the particles */
    100100  inline float getEndRadius() { return this->radiusAnim.getValue(1.0); };
    101   /** \returns the conserve-factor of the particles */
     101  /** @returns the conserve-factor of the particles */
    102102  inline float getConserve() const { return this->conserve; };
    103   /** \returns the initial mass of the particles */
     103  /** @returns the initial mass of the particles */
    104104  inline float getMass() const { return this->initialMass; };
    105105
    … …  
    108108
    109109  virtual void applyField(Field* field);
    110   /** \brief this is an empty function, because the Physics are implemented in tick \param dt: useless here */
     110  /** \brief this is an empty function, because the Physics are implemented in tick @param dt: useless here */
    111111  virtual void tickPhys(float dt) {};
    112112

  • orxonox/trunk/src/lib/particles/quick_animation.cc

    r4746 r4836  
    2828
    2929/**
    30    \brief standard constructor
     30 * standard constructor
    3131*/
    3232QuickAnimation::QuickAnimation ()
    … …  
    4343
    4444/**
    45    \brief deletes all the deconstructor stuff
     45 * deletes all the deconstructor stuff
    4646*/
    4747QuickAnimation::~QuickAnimation ()
    … …  
    6060
    6161/**
    62    \brief adds a new entry to the list of keyframes
    63    \param position the position to add the key to
    64    \param value the Value to set for the position
    65    \returns false if the key existed already for a given position
     62 * adds a new entry to the list of keyframes
     63 * @param position the position to add the key to
     64 * @param value the Value to set for the position
     65 * @returns false if the key existed already for a given position
    6666*/
    6767void QuickAnimation::addEntry(float position, float value)
    … …  
    128128
    129129/**
    130    \brief changes an entry in the region of position
    131    \param position the Position of an existing keyframe
    132    \param region a deviation of the existing keyframe (like a delta in witch to search for
    133    \param value the new Value
     130 * changes an entry in the region of position
     131 * @param position the Position of an existing keyframe
     132 * @param region a deviation of the existing keyframe (like a delta in witch to search for
     133 * @param value the new Value
    134134
    135135   if the Entry at the in the region of the specified position is found, it will be changed.
    136136    Otherwise a new KeyFrame will be created with value at position.
    137    \todo rimplement
     137   @todo rimplement
    138138*/
    139139void QuickAnimation::changeEntry(float position, float value, float region)
    … …  
    202202
    203203/**
    204    \brief returns the value of the animation at a certain position
    205    \param position the position to get the value from :)
     204 * returns the value of the animation at a certain position
     205 * @param position the position to get the value from :)
    206206*/
    207207float QuickAnimation::getValue(float position)
    … …  
    226226
    227227/**
    228    \brief outputs some nice information about this class
     228 * outputs some nice information about this class
    229229*/
    230230void QuickAnimation::debug()

  • orxonox/trunk/src/lib/particles/quick_animation.h

    r4746 r4836  
    11/*!
    22    \file quick_animation.h
    3     \brief Definition of the QuickAnimation-class
     3  * Definition of the QuickAnimation-class
    44
    55*/
    … …  
    4343
    4444  void removeEntry(float position);
    45   /** \todo implemente those functions
     45  /** @todo implemente those functions
    4646      bool moveEntry(float position);
    4747  */

  • orxonox/trunk/src/lib/physics/fields/field.cc

    r4746 r4836  
    2525
    2626/**
    27    \brief standard constructor
     27 * standard constructor
    2828*/
    2929Field::Field ()
    … …  
    3333
    3434/**
    35    \brief standard deconstructor
     35 * standard deconstructor
    3636
    3737*/
    … …  
    5454
    5555/**
    56   \param root The XML-element to load settings from
     56* @param root The XML-element to load settings from
    5757 */
    5858void Field::loadParams(const TiXmlElement* root)
    … …  
    6969
    7070/**
    71    \param magnitude the magnitude of the Field.
     71 * @param magnitude the magnitude of the Field.
    7272*/
    7373void Field::setMagnitude(float magnitude)
    … …  
    7777
    7878/**
    79    \param attenuation The attenuation of the Field (the bigger the smaller the region of influence)
     79 * @param attenuation The attenuation of the Field (the bigger the smaller the region of influence)
    8080*/
    8181void Field::setAttenuation(float attenuation)

  • orxonox/trunk/src/lib/physics/fields/field.h

    r4746 r4836  
    1616/*!
    1717    \file field.h
    18     \brief abstract definition of a Physical Field
     18  * abstract definition of a Physical Field
    1919
    2020    This is a totally abstract class, that only enables different Physical Fields to
    … …  
    4242
    4343  /**
    44       \param data This is the data given to this force, to calculate the ForceVector
    45       \returns The Force Vector
     44    * @param data This is the data given to this force, to calculate the ForceVector
     45    * @returns The Force Vector
    4646  */
    4747  virtual Vector calcForce(const Vector& data) const = 0;
    4848
    4949  void setMagnitude(float magnitude);
    50   /** \returns The Magnitude of the Field */
     50  /** @returns The Magnitude of the Field */
    5151  inline const float& getMagnitude() const {return this->magnitude;}
    5252
    5353  void setAttenuation(float attenuation);
    54   /** \returns The Attenuation of the Fiels */
     54  /** @returns The Attenuation of the Fiels */
    5555  inline const float& getAttenuation() const {return this->attenuation;}
    5656

  • orxonox/trunk/src/lib/physics/fields/fields.h

    r4338 r4836  
    1616/*!
    1717    \file fields.h
    18     \brief collection of all Headers of all the different fileds there are in the
     18  * collection of all Headers of all the different fileds there are in the
    1919    PhysicsEngine
    2020*/

  • orxonox/trunk/src/lib/physics/fields/gravity.cc

    r4742 r4836  
    3434
    3535/**
    36    \brief standard deconstructor
     36 * standard deconstructor
    3737
    3838*/
    … …  
    4848
    4949/**
    50    \brief calculates the Gravity on any point in space
    51    \param data The Position of the Point in space to attache gravity to.
    52    \returns The force.
     50 * calculates the Gravity on any point in space
     51 * @param data The Position of the Point in space to attache gravity to.
     52 * @returns The force.
    5353*/
    5454Vector Gravity::calcForce(const Vector& data) const

  • orxonox/trunk/src/lib/physics/fields/gravity.h

    r4742 r4836  
    11/*!
    22    \file gravity.h
    3     \brief Definition of ...
     3  * Definition of ...
    44
    55*/

  • orxonox/trunk/src/lib/physics/fields/point_gravity.cc

    r4742 r4836  
    2222
    2323/**
    24    \brief standard constructor
    25    \todo this constructor is not jet implemented - do it
     24 * standard constructor
     25   @todo this constructor is not jet implemented - do it
    2626*/
    2727PointGravity::PointGravity ()
    … …  
    3232
    3333/**
    34    \brief standard deconstructor
     34 * standard deconstructor
    3535
    3636*/
    … …  
    4141
    4242/**
    43    \brief calculates the PointGravity on any point in space
    44    \param data The Position of the Point in space to attache PointGravity to.
    45    \returns The force.
     43 * calculates the PointGravity on any point in space
     44 * @param data The Position of the Point in space to attache PointGravity to.
     45 * @returns The force.
    4646*/
    4747Vector PointGravity::calcForce(const Vector& data) const

  • orxonox/trunk/src/lib/physics/fields/point_gravity.h

    r4395 r4836  
    11/*!
    22    \file point_gravity.h
    3     \brief Definition of ...
     3  * Definition of ...
    44
    55*/

  • orxonox/trunk/src/lib/physics/fields/twirl.cc

    r4742 r4836  
    2222
    2323/**
    24    \brief standard constructor
    25    \todo this constructor is not jet implemented - do it
     24 * standard constructor
     25   @todo this constructor is not jet implemented - do it
    2626*/
    2727Twirl::Twirl ()
    … …  
    3232
    3333/**
    34    \brief standard deconstructor
     34 * standard deconstructor
    3535
    3636*/
    … …  
    4141
    4242/**
    43    \brief calculates the Twirl on any point in space
    44    \param data The Position of the Point in space to attache twirl to.
    45    \returns The force.
     43 * calculates the Twirl on any point in space
     44 * @param data The Position of the Point in space to attache twirl to.
     45 * @returns The force.
    4646*/
    4747Vector Twirl::calcForce(const Vector& data) const

  • orxonox/trunk/src/lib/physics/fields/twirl.h

    r4395 r4836  
    11/*!
    22    \file twirl.h
    3     \brief Definition of ...
     3  * Definition of ...
    44
    55*/

  • orxonox/trunk/src/lib/physics/physics_connection.cc

    r4746 r4836  
    3131
    3232/**
    33    \brief creates a PhysicsConnection
     33 * creates a PhysicsConnection
    3434*/
    3535PhysicsConnection::PhysicsConnection(PhysicsInterface* subject, Field* field)
    … …  
    6161
    6262/**
    63    \brief standard deconstructor
     63 * standard deconstructor
    6464
    6565*/
    … …  
    7070
    7171/**
    72    \param subjectName the name of the Subject for this PhysicsConnection
     72 * @param subjectName the name of the Subject for this PhysicsConnection
    7373*/
    7474void PhysicsConnection::setSubject(const char* subjectName)
    … …  
    8484
    8585/**
    86   \param fieldName the Name of the Field for this connection
     86* @param fieldName the Name of the Field for this connection
    8787*/
    8888void PhysicsConnection::setField(const char* fieldName)
    … …  
    9999
    100100/**
    101     \brief applies the Force to some Object.
     101  * applies the Force to some Object.
    102102*/
    103103void PhysicsConnection::apply() const

  • orxonox/trunk/src/lib/physics/physics_connection.h

    r4746 r4836  
    11/*!
    22    \file physics_connection.h
    3     \brief Definition of The Physical Connection Class.
     3  * Definition of The Physical Connection Class.
    44*/
    55

  • orxonox/trunk/src/lib/physics/physics_engine.cc

    r4749 r4836  
    2929
    3030/**
    31    \brief standard constructor
     31 * standard constructor
    3232*/
    3333PhysicsEngine::PhysicsEngine()
    … …  
    4141
    4242/**
    43    \brief the singleton reference to this class
     43 * the singleton reference to this class
    4444*/
    4545PhysicsEngine* PhysicsEngine::singletonRef = NULL;
    4646
    4747/**
    48    \brief standard deconstructor
     48 * standard deconstructor
    4949
    5050*/
    … …  
    9191
    9292/**
    93   \param root the XML-element to load settings from
     93* @param root the XML-element to load settings from
    9494 */
    9595void PhysicsEngine::loadParams(const TiXmlElement* root)
    … …  
    103103
    104104/**
    105  * \param root the XML-element to Load the PhysicsField from
     105 * @param root the XML-element to Load the PhysicsField from
    106106 */
    107107void PhysicsEngine::loadFields(const TiXmlElement* root)
    … …  
    119119
    120120/**
    121  * \param root the XML-element to load the PhysicsConnection from
     121 * @param root the XML-element to load the PhysicsConnection from
    122122 */
    123123void PhysicsEngine::loadConnections(const TiXmlElement* root)
    … …  
    135135
    136136/**
    137    \brief adds a PhysicsInterface to the list of handeled physicsInterfaces
    138    \param physicsInterface the interface to add
     137 * adds a PhysicsInterface to the list of handeled physicsInterfaces
     138 * @param physicsInterface the interface to add
    139139
    140140   this is normally done in the constructor of any PhysicsInterface
    … …  
    146146
    147147/**
    148    \brief removes a PhysicsInterface from the list of handeled physicsInterfaces
    149    \param physicsInterface the interface to remove
     148 * removes a PhysicsInterface from the list of handeled physicsInterfaces
     149 * @param physicsInterface the interface to remove
    150150
    151151   this is normally done in the destructor of any PhysicsInterface
    … …  
    157157
    158158/**
    159   \param physicsInterfaceName the Name of the PhysicsInterface to search for
    160   \returns the PhysicsInterface if found, or NULL if not
     159* @param physicsInterfaceName the Name of the PhysicsInterface to search for
     160  @returns the PhysicsInterface if found, or NULL if not
    161161 */
    162162PhysicsInterface* PhysicsEngine::getPhysicsInterfaceByName(const char* physicsInterfaceName) const
    … …  
    178178
    179179/**
    180    \brief adds a Field to the list of handeled fields
    181    \param field the field to add
     180 * adds a Field to the list of handeled fields
     181 * @param field the field to add
    182182
    183183   this is normally done in the constructor of any Field
    … …  
    189189
    190190/**
    191    \brief removes a Field from the list of handeled fields
    192    \param field the field to remove
     191 * removes a Field from the list of handeled fields
     192 * @param field the field to remove
    193193
    194194   this is normally done in the destructor of any Field
    … …  
    200200
    201201/**
    202   \param FieldName the Name of the PhysicsInterface to search for
    203   \returns the Field if found, or NULL if not
     202* @param FieldName the Name of the PhysicsInterface to search for
     203  @returns the Field if found, or NULL if not
    204204 */
    205205Field* PhysicsEngine::getFieldByName(const char* FieldName) const
    … …  
    223223
    224224/**
    225    \brief adds A Physical Connection to the List of Connections
    226    \param connection the Connection to add
     225 * adds A Physical Connection to the List of Connections
     226 * @param connection the Connection to add
    227227
    228228   Usually this is done through the constructor of PhysicshConnections
    … …  
    234234
    235235/**
    236    \brief removes A Physical Connection from the List of Connections
    237    \param connection the Connection to remove
     236 * removes A Physical Connection from the List of Connections
     237 * @param connection the Connection to remove
    238238
    239239   Usually this is done through the destructor of PhysicsConnections
    … …  
    245245
    246246/**
    247   \param physicsConnectionName the Name of the PhysicsInterface to search for
    248   \returns the PhysicsConnection if found, or NULL if not
     247* @param physicsConnectionName the Name of the PhysicsInterface to search for
     248  @returns the PhysicsConnection if found, or NULL if not
    249249 */
    250250PhysicsConnection* PhysicsEngine::getPhysicsConnectionByName(const char* physicsConnectionName) const
    … …  
    268268
    269269/**
    270    \brief Steps through all the Connections and Ticks them
    271    \param dt The time Passed in Seconds
     270 * Steps through all the Connections and Ticks them
     271 * @param dt The time Passed in Seconds
    272272
    273273   This function brings a flow into the whole animation
    … …  
    302302
    303303/**
    304    \brief print out interesting debug information of this class
     304 * print out interesting debug information of this class
    305305*/
    306306void PhysicsEngine::debug() const

  • orxonox/trunk/src/lib/physics/physics_engine.h

    r4746 r4836  
    11/*!
    22    \file physics_engine.h
    3     \brief Definition of the PhysicsEngine-singleton Class
     3  * Definition of the PhysicsEngine-singleton Class
    44
    55*/
    … …  
    2323 public:
    2424  virtual ~PhysicsEngine();
    25   /** \returns a Pointer to the only object of this Class */
     25  /** @returns a Pointer to the only object of this Class */
    2626  inline static PhysicsEngine* getInstance() { if (!singletonRef) singletonRef = new PhysicsEngine();  return singletonRef; };
    2727

  • orxonox/trunk/src/lib/physics/physics_interface.cc

    r4762 r4836  
    3434
    3535/**
    36    \brief standard constructor
     36 * standard constructor
    3737 */
    3838PhysicsInterface::PhysicsInterface ()
    … …  
    4949
    5050/**
    51    \brief standard deconstructor
     51 * standard deconstructor
    5252*/
    5353PhysicsInterface::~PhysicsInterface ()
    … …  
    5757
    5858/**
    59    \brief recalculates the total mass of all the children of this node
     59 * recalculates the total mass of all the children of this node
    6060
    6161   (only availiable for PNodes)
    … …  
    6464{
    6565  /*
    66     PNode* massCalcPNode = dynamic_cast<PNode*>(this);  //! \todo not sure if this will work ....
     66    PNode* massCalcPNode = dynamic_cast<PNode*>(this);  //! @todo not sure if this will work ....
    6767    float massSum = 0;
    6868
    … …  
    9090
    9191/**
    92    \brief applyes a field to this Object
    93    \param field the field to apply
     92 * applyes a field to this Object
     93 * @param field the field to apply
    9494*/
    9595void PhysicsInterface::applyField(Field* field)
    … …  
    101101
    102102/**
    103    \brief ticks the PhysicsEffect
    104    \param dt: the value about which to tick
     103 * ticks the PhysicsEffect
     104 * @param dt: the value about which to tick
    105105*/
    106106void PhysicsInterface::tickPhys( float dt )

  • orxonox/trunk/src/lib/physics/physics_interface.h

    r4762 r4836  
    11/*!
    22    \file physics_interface.h
    3     \brief a physics interface simulating a body with a mass
     3  * a physics interface simulating a body with a mass
    44*/
    55
    … …  
    3131  PhysicsInterface();
    3232  virtual ~PhysicsInterface();
    33   /** \param mass the mass to set for this node. */
     33  /** @param mass the mass to set for this node. */
    3434  inline void setMass( float mass ) { this->mass = mass; };
    35   /** \returns the mass of the node. */
     35  /** @returns the mass of the node. */
    3636  inline float getMass( void ) const { return mass; };
    37   /** \returns the mass of this node plus all its children (only valid for PNodes). */
     37  /** @returns the mass of this node plus all its children (only valid for PNodes). */
    3838  inline float getTotalMass( void ) const { return mass + massChildren; };
    3939

  • orxonox/trunk/src/lib/sound/ogg_player.h

    r4750 r4836  
    11/*!
    22 * @file ogg_player.h
    3  * @brief Ogg-Player definition
     3 * Ogg-Player definition
    44 */
    55

  • orxonox/trunk/src/lib/sound/sound_engine.cc

    r4830 r4836  
    3535//////////////////
    3636/**
    37    \brief Creates a Soundbuffer out of an inputfile
    38    \param fileName The name of the File
     37 * Creates a Soundbuffer out of an inputfile
     38 * @param fileName The name of the File
    3939*/
    4040SoundBuffer::SoundBuffer(const char* fileName)
    … …  
    8989//////////////////
    9090/**
    91    \brief creates a SoundSource at position sourceNode with the SoundBuffer buffer
     91 * creates a SoundSource at position sourceNode with the SoundBuffer buffer
    9292*/
    9393SoundSource::SoundSource(SoundBuffer* buffer, PNode* sourceNode)
    … …  
    113113
    114114/**
    115    \brief deletes a SoundSource
     115 * deletes a SoundSource
    116116*/
    117117SoundSource::~SoundSource()
    … …  
    123123
    124124/**
    125    \brief Plays back a SoundSource
     125 * Plays back a SoundSource
    126126*/
    127127void SoundSource::play()
    … …  
    131131
    132132/**
    133    \brief Stops playback of a SoundSource
     133 * Stops playback of a SoundSource
    134134*/
    135135void SoundSource::stop()
    … …  
    139139
    140140/**
    141    \brief Pauses Playback of a SoundSource
     141 * Pauses Playback of a SoundSource
    142142*/
    143143void SoundSource::pause()
    … …  
    147147
    148148/**
    149    \brief Rewinds Playback of a SoundSource
     149 * Rewinds Playback of a SoundSource
    150150*/
    151151void SoundSource::rewind()
    … …  
    155155
    156156/**
    157    \brief sets the RolloffFactor of the Sound emitted from the SoundSource
    158    \param rolloffFactor The Factor described
     157 * sets the RolloffFactor of the Sound emitted from the SoundSource
     158 * @param rolloffFactor The Factor described
    159159
    160160   this tells openAL how fast the Sounds decay outward from the Source
    … …  
    171171//////////////////
    172172/**
    173    \brief standard constructor
     173 * standard constructor
    174174*/
    175175SoundEngine::SoundEngine ()
    … …  
    184184
    185185/**
    186    \brief the singleton reference to this class
     186 * the singleton reference to this class
    187187*/
    188188SoundEngine* SoundEngine::singletonRef = NULL;
    189189
    190190/**
    191    \brief standard deconstructor
     191 * standard deconstructor
    192192
    193193*/
    … …  
    221221
    222222/**
    223    \brief creates a new SoundSource.
    224    \param fileName The Name to load the SoundBuffer from
    225    \param sourceNode The sourceNode to bind this SoundSource to.
    226    \returns The newly created SoundSource
     223 * creates a new SoundSource.
     224 * @param fileName The Name to load the SoundBuffer from
     225 * @param sourceNode The sourceNode to bind this SoundSource to.
     226 * @returns The newly created SoundSource
    227227
    228228   acctualy this is nothing more than a wrapper around the ResourceManager.
    … …  
    235235
    236236/**
    237    \brief sets The listener (normaly the Camera)
     237 * sets The listener (normaly the Camera)
    238238*/
    239239void SoundEngine::setListener(PNode* listener)
    … …  
    243243
    244244/**
    245    \brief Sets the doppler values of openAL
    246    \param dopplerFactor the extent of the doppler-effect
    247    \param dopplerVelocity the Speed the sound travels
     245 * Sets the doppler values of openAL
     246 * @param dopplerFactor the extent of the doppler-effect
     247 * @param dopplerVelocity the Speed the sound travels
    248248*/
    249249void SoundEngine::setDopplerValues(ALfloat dopplerFactor, ALfloat dopplerVelocity)
    … …  
    255255
    256256/**
    257    \brief adds a SoundBuffer to the bufferList of the SoundEngine
    258    \param buffer The buffer to add to the bufferList
     257 * adds a SoundBuffer to the bufferList of the SoundEngine
     258 * @param buffer The buffer to add to the bufferList
    259259*/
    260260void SoundEngine::addBuffer(SoundBuffer* buffer)
    … …  
    264264
    265265/**
    266    \brief removes a SoundBuffer from the bufferList of the SoundEngine
    267    \param buffer The buffer to delete from the SoundEngine
     266 * removes a SoundBuffer from the bufferList of the SoundEngine
     267 * @param buffer The buffer to delete from the SoundEngine
    268268*/
    269269void SoundEngine::removeBuffer(SoundBuffer* buffer)
    … …  
    285285
    286286/**
    287    \brief adds a SoundSource to the sourceList of the SoundEngine
    288    \param source The source to add to the sourceList
     287 * adds a SoundSource to the sourceList of the SoundEngine
     288 * @param source The source to add to the sourceList
    289289*/
    290290void SoundEngine::addSource(SoundSource* source)
    … …  
    294294
    295295/**
    296    \brief removes a SoundSource from the sourceList of the SoundEngine
    297    \param source The source to delete from the SoundEngine
     296 * removes a SoundSource from the sourceList of the SoundEngine
     297 * @param source The source to delete from the SoundEngine
    298298*/
    299299void SoundEngine::removeSource(SoundSource* source)
    … …  
    304304
    305305/**
    306    \brief updates all The positions, Directions and Velocities of all Sounds
     306 * updates all The positions, Directions and Velocities of all Sounds
    307307*/
    308308void SoundEngine::update()
    … …  
    349349
    350350/**
    351    \brief Removes all the Buffers that are not anymore needed by any Sources
     351 * Removes all the Buffers that are not anymore needed by any Sources
    352352*/
    353353void SoundEngine::flushUnusedBuffers()
    … …  
    374374
    375375/**
    376    \brief SourceEngine::flushAllBuffers
     376 * SourceEngine::flushAllBuffers
    377377*/
    378378void SoundEngine::flushAllBuffers()
    … …  
    389389
    390390/**
    391   * @brief SourceEngine::flushAllBuffers
     391  * SourceEngine::flushAllBuffers
    392392 */
    393393void SoundEngine::flushAllSources()
    … …  
    405405
    406406/**
    407    \brief initializes Audio in general
     407 * initializes Audio in general
    408408*/
    409409bool SoundEngine::initAudio()
    … …  
    421421
    422422/**
    423    \brief Transforms AL-errors into something readable
    424    \param err The error found
     423 * Transforms AL-errors into something readable
     424 * @param err The error found
    425425*/
    426426void SoundEngine::PrintALErrorString(ALenum err)

  • orxonox/trunk/src/lib/sound/sound_engine.h

    r4830 r4836  
    11/*!
    22    \file sound_engine.h
    3     \brief Definition of the SoundEngine singleton Class
     3  * Definition of the SoundEngine singleton Class
    44*/
    55
    … …  
    2626  ~SoundBuffer();
    2727
    28   /** \returns the ID of the buffer used in this SoundBuffer */
     28  /** @returns the ID of the buffer used in this SoundBuffer */
    2929  inline ALuint getID() { return this->bufferID; }
    3030
    … …  
    5050
    5151  // development functions
    52   /** \returns The ID of this Source */
     52  /** @returns The ID of this Source */
    5353  inline ALuint getID() const { return this->sourceID; }
    54   /** \returns the SoundBuffer of this Source */
     54  /** @returns the SoundBuffer of this Source */
    5555  inline SoundBuffer* getBuffer() const { return this->buffer; }
    56   /** \returns the SourceNode of this Source */
     56  /** @returns the SourceNode of this Source */
    5757  inline PNode* getNode() const { return this->sourceNode;}
    5858
    … …  
    7272 public:
    7373  virtual ~SoundEngine();
    74   /** \returns a Pointer to the only object of this Class */
     74  /** @returns a Pointer to the only object of this Class */
    7575  inline static SoundEngine* getInstance() { if (!singletonRef) singletonRef = new SoundEngine();  return singletonRef; };
    7676

  • orxonox/trunk/src/lib/util/ini_parser.cc

    r4767 r4836  
    2323
    2424/**
    25    \brief constructs an IniParser using a file
    26    \param filename: the path and name of the file to parse
     25 * constructs an IniParser using a file
     26 * @param filename: the path and name of the file to parse
    2727*/
    2828IniParser::IniParser (const char* filename)
    … …  
    3636
    3737/**
    38    \brief removes the IniParser from memory
     38 * removes the IniParser from memory
    3939*/
    4040IniParser::~IniParser ()
    … …  
    4444
    4545/**
    46    \brief opens another file to parse
    47    \param filename: path and name of the new file to parse
    48    \return zero on success or -1 if an error occured;
     46 * opens another file to parse
     47 * @param filename: path and name of the new file to parse
     48 * @return zero on success or -1 if an error occured;
    4949*/
    5050int IniParser::openFile(const char* filename)
    … …  
    6565
    6666/**
    67    \brief set the parsing cursor to the specified section
    68    \param section: the name of the section to set the cursor to
    69    \return zero on success or -1 if the section could not be found
     67 * set the parsing cursor to the specified section
     68 * @param section: the name of the section to set the cursor to
     69 * @return zero on success or -1 if the section could not be found
    7070*/
    7171int IniParser::getSection( const char* section)
    … …  
    103103
    104104/**
    105    \brief gets the next VarName=VarValue pair from the parsing stream
    106    \param name: a pointer to a buffer to store the name of the entry
    107    \param value: a pointer to a buffer to store the value of the entry
    108    \return zero if the buffers have been filled with data or -1 if there are no entries left in the current section
     105 * gets the next VarName=VarValue pair from the parsing stream
     106 * @param name: a pointer to a buffer to store the name of the entry
     107 * @param value: a pointer to a buffer to store the value of the entry
     108 * @return zero if the buffers have been filled with data or -1 if there are no entries left in the current section
    109109*/
    110110int IniParser::nextVar( const char* name, const char* value)
    … …  
    148148
    149149/**
    150    \brief directly acesses an entry in a section
    151    \param name: the name of the entry to find
    152    \param section: the section where the entry is to be found
    153    \param defvalue: what should be returned in case the entry cannot be found
    154    \return a pointer to a buffer conatining the value of the specified entry. This buffer will contain the data specified in defvalue in case the entry wasn't found
     150 * directly acesses an entry in a section
     151 * @param name: the name of the entry to find
     152 * @param section: the section where the entry is to be found
     153 * @param defvalue: what should be returned in case the entry cannot be found
     154 * @return a pointer to a buffer conatining the value of the specified entry. This buffer will contain the data specified in defvalue in case the entry wasn't found
    155155
    156156   The returned pointer points to an internal buffer, so do not free it on your own. Do not give a NULL pointer to defvalue, this will certainly

  • orxonox/trunk/src/lib/util/ini_parser.h

    r4767 r4836  
    11/*!
    22    \file ini_parser.h
    3     \brief A small ini file parser
     3  * A small ini file parser
    44
    55    Can be used to find a defined [Section] in an ini file and get the VarName=Value entries

  • orxonox/trunk/src/lib/util/list.h

    r4694 r4836  
    2323
    2424/**
    25    \brief an iterator class
     25 * an iterator class
    2626
    2727   this enables the user to iterate through a list very easely
    … …  
    4444
    4545/**
    46    \brief iterator constructor
    47    \param startElement:  the first list element from the tList
     46 * iterator constructor
     47 * @param startElement:  the first list element from the tList
    4848
    4949   normaly you will use it like this:
    … …  
    6868
    6969/**
    70    \brief the destructor
     70 * the destructor
    7171*/
    7272template<class T>
    … …  
    7878
    7979/**
    80    \brief use it to iterate through the list
    81    \returns next list element
     80 * use it to iterate through the list
     81 * @returns next list element
    8282*/
    8383template<class T>
    … …  
    9393
    9494/**
    95    \brief gets the element after the selected one, sets the iterator to this point in the list
    96    \param element the element to seek
    97    \returns next list element
     95 * gets the element after the selected one, sets the iterator to this point in the list
     96 * @param element the element to seek
     97 * @returns next list element
    9898
    9999  Attention: if you seek an element, the iterator pointer will point to the NEXT listelement after the argument!
    … …  
    120120
    121121/**
    122    \brief the list template class
     122 * the list template class
    123123
    124124   you will use this as a generic list for all type of objects
    … …  
    151151
    152152/**
    153    \brief the constructor
     153 * the constructor
    154154*/
    155155template<class T>
    … …  
    163163
    164164/**
    165    \brief the deconstructor
     165 * the deconstructor
    166166
    167167   this will delete only the list. ATTENTION: the list is deleted, but the objects in the list will
    … …  
    186186
    187187/**
    188    \brief add an entity to the list
    189    \param entity: the entity to add
     188 * add an entity to the list
     189 * @param entity: the entity to add
    190190*/
    191191template<class T>
    … …  
    207207
    208208/**
    209    \brief remove an entity from the list
    210    \param entity: the entity to be removed
     209 * remove an entity from the list
     210 * @param entity: the entity to be removed
    211211*/
    212212template<class T>
    … …  
    235235
    236236/**
    237    \brief this will deletes the objects from the list
     237 * this will deletes the objects from the list
    238238*/
    239239template<class T>
    … …  
    255255
    256256/**
    257    \brief returns the first element of the list
    258    \returns first element
     257 * returns the first element of the list
     258 * @returns first element
    259259*/
    260260template<class T>
    … …  
    266266
    267267/**
    268    \brief function returns the last element of the list
    269    \returns the last element
     268 * function returns the last element of the list
     269 * @returns the last element
    270270*/
    271271template<class T>
    … …  
    277277
    278278/**
    279    \brief returns true if the list is empty
    280    \returns true if the list is empty
     279 * returns true if the list is empty
     280 * @returns true if the list is empty
    281281*/
    282282template<class T>
    … …  
    287287
    288288/**
    289    \brief checks if an entity is in the List
    290    \param entity The entity to check for in the entire List.
    291    \returns true if it is, false otherwise
     289 * checks if an entity is in the List
     290 * @param entity The entity to check for in the entire List.
     291 * @returns true if it is, false otherwise
    292292*/
    293293template<class T>
    … …  
    311311
    312312/**
    313    \brief this returns the number of elements in the list
    314    \returns number of elements
     313 * this returns the number of elements in the list
     314 * @returns number of elements
    315315*/
    316316template<class T>
    … …  
    322322
    323323/**
    324    \brief creates an itereator object and returns it
    325    \returns the iterator object to this list
     324 * creates an itereator object and returns it
     325 * @returns the iterator object to this list
    326326
    327327   You will use this, if you want to iterate through the list
    … …  
    337337
    338338/**
    339    \brief this returns the next element after toEntity or the first if toEntity is last
    340    \param toEntity: the entity after which is an entity, that has to be returned, sorry, terrible phrase
    341    \returns the element after toEntity
     339 * this returns the next element after toEntity or the first if toEntity is last
     340 * @param toEntity: the entity after which is an entity, that has to be returned, sorry, terrible phrase
     341 * @returns the element after toEntity
    342342*/
    343343template<class T>
    … …  
    359359
    360360/**
    361    \brief creates an array out of the list (ATTENTION: not implemented)
    362    \returns pointer to the array beginning
     361 * creates an array out of the list (ATTENTION: not implemented)
     362 * @returns pointer to the array beginning
    363363
    364364   ATTENTION: function is not implemented and wont do anything

  • orxonox/trunk/src/lib/util/substring.cc

    r4833 r4836  
    1818
    1919/**
    20    \brief breaks a string into parts that were initially seperated by comma
    21    \param string the string to break into substrings
     20 * breaks a string into parts that were initially seperated by comma
     21 * @param string the string to break into substrings
    2222*/
    2323
    … …  
    6868
    6969/**
    70    \brief removes the object from memory
     70 * removes the object from memory
    7171*/
    7272SubString::~SubString()
    … …  
    8181
    8282/**
    83    \brief get a particular substring
    84    \param i the ID of the substring to return
    85    \returns the designated substring or NULL if an invalid ID was given
     83 * get a particular substring
     84 * @param i the ID of the substring to return
     85 * @returns the designated substring or NULL if an invalid ID was given
    8686*/
    8787const char* SubString::getString( int i)

  • orxonox/trunk/src/orxonox.cc

    r4833 r4836  
    5757
    5858/**
    59    \brief create a new Orxonox
     59 * create a new Orxonox
    6060
    6161   In this funcitons only global values are set. The game will not be started here.
    … …  
    7676
    7777/**
    78    \brief remove Orxonox from memory
     78 * remove Orxonox from memory
    7979*/
    8080Orxonox::~Orxonox ()
    … …  
    109109
    110110/**
    111  * @brief this is a singleton class to prevent duplicates
     111 * this is a singleton class to prevent duplicates
    112112 */
    113113Orxonox* Orxonox::singletonRef = NULL;
    114114
    115115/**
    116  * @brief this finds the config file
     116 * this finds the config file
    117117 * @returns the new config-fileName
    118118 * Since the config file varies from user to user and since one may want to specify different config files
    … …  
    252252    exit(-1);
    253253  }
    254    //! \todo this is a hack and should be loadable
     254   //! @todo this is a hack and should be loadable
    255255  ResourceManager::getInstance()->addImageDir(ResourceManager::getInstance()->getFullName("maps/"));
    256256  ResourceManager::getInstance()->debug();
    … …  
    267267
    268268/**
    269  *
    270  * @brief starts the orxonox game or menu
     269 *  starts the orxonox game or menu
    271270 * here is the central orxonox state manager. There are currently two states
    272271 * - menu
    … …  
    315314/**
    316315 *
    317  * @brief main function
     316 * main function
    318317 *
    319318 * here the journey begins

  • orxonox/trunk/src/orxonox.h

    r4830 r4836  
    11/*!
    22    \file orxonox.h
    3     \brief Orxonox core functions
     3  * Orxonox core functions
    44*/
    55
    … …  
    2121 public:
    2222  virtual ~Orxonox ();
    23   /** \returns a Pointer to the only object of this Class */
     23  /** @returns a Pointer to the only object of this Class */
    2424  inline static Orxonox* getInstance() { if (!singletonRef) singletonRef = new Orxonox();  return singletonRef; };
    2525

  • orxonox/trunk/src/story_entities/campaign.cc

    r4816 r4836  
    6868/**
    6969  \brief loads the Parameters of a Campaign
    70   \param root: The XML-element to load from
     70* @param root: The XML-element to load from
    7171 */
    7272void Campaign::loadParams(const TiXmlElement* root)
    … …  
    8383/**
    8484  \brief loads a WorldList
    85   \param root: the XML-element to load from
     85* @param root: the XML-element to load from
    8686 */
    8787void Campaign::loadWorldListParams(const TiXmlElement* root)
    … …  
    200200
    201201/**
    202     \brief adds an game stroy entity to the campaign
    203 
    204     \param se: The entity
    205     \param storyID: The number that identifies the entity in the campaign. Each ID only used once in a Campaign
     202  * adds an game stroy entity to the campaign
     203
     204  * @param se: The entity
     205  * @param storyID: The number that identifies the entity in the campaign. Each ID only used once in a Campaign
    206206
    207207    An entity can be a world (playable), a cinematic, a shop, sounds, whatever you
    … …  
    253253/*
    254254  \brief lookup a entity with a given id
    255   \param story id to be lookuped
    256   \returns the entity found or NULL if search ended without match
     255* @param story id to be lookuped
     256  @returns the entity found or NULL if search ended without match
    257257*/
    258258StoryEntity* Campaign::getStoryEntity(int storyID)

  • orxonox/trunk/src/story_entities/story_entity.cc

    r4597 r4836  
    3232
    3333/**
    34     \brief sets the story ID
     34  * sets the story ID
    3535
    3636    sets the story id of the current entity, this enables it to be identified in a
    … …  
    4444
    4545/**
    46     \brief this reads the story id of the current entity
    47     \returns the story entity id
     46  * this reads the story id of the current entity
     47  * @returns the story entity id
    4848*/
    4949int StoryEntity::getStoryID()
    … …  
    5454
    5555/**
    56     \brief sets the id of the next story entity
     56  * sets the id of the next story entity
    5757
    5858    StoryEntities can choose their following entity themselfs. the entity id defined here
    … …  
    6666
    6767/**
    68     \brief gets the story id of the current entity
    69     \returns story id
     68  * gets the story id of the current entity
     69  * @returns story id
    7070*/
    7171int StoryEntity::getNextStoryID()
    … …  
    7676
    7777/**
    78    \brief stuff that will have to be initialized before load
     78 * stuff that will have to be initialized before load
    7979
    8080   this gives all storyentities the possibility to init stuff before the
    … …  
    8585
    8686/**
    87     \brief loads the current entity
     87  * loads the current entity
    8888
    8989    this is here to enable you loading maps into the entities. for all other actions you
    … …  
    9696
    9797/**
    98     \brief initialize the entity before use.
    99     \returns an error code if not able to apply.
     98  * initialize the entity before use.
     99  * @returns an error code if not able to apply.
    100100
    101101    After execution of this function, the Entity is ready to be played/executed,
    … …  
    108108
    109109/**
    110     \brief starts the entity with the choosen id. only for entities with lists.
    111     \param story id
    112     \returns error code if this action has caused a error
     110  * starts the entity with the choosen id. only for entities with lists.
     111  * @param story id
     112  * @returns error code if this action has caused a error
    113113
    114114    this simply starts the story with the id storyID. the story with the choosen id has
    … …  
    122122
    123123/**
    124     \brief starts the current entity
    125     \returns error code if this action has caused a error
     124  * starts the current entity
     125  * @returns error code if this action has caused a error
    126126*/
    127127ErrorMessage StoryEntity::start()
    … …  
    130130
    131131/**
    132     \brief pause the current entity
    133     \returns error code if this action has caused a error
     132  * pause the current entity
     133  * @returns error code if this action has caused a error
    134134
    135135    this pauses the current entity or passes this call forth to the running entity.
    … …  
    140140
    141141/**
    142     \brief resumes a pause
    143     \returns error code if this action has caused a error
     142  * resumes a pause
     143  * @returns error code if this action has caused a error
    144144
    145145    this resumess the current entity or passes this call forth to the running entity.
    … …  
    150150
    151151/**
    152     \brief stops the current entity
    153     \returns error code if this action has caused a error
     152  * stops the current entity
     153  * @returns error code if this action has caused a error
    154154
    155155    ATTENTION: this function shouldn't call other functions, or if so, they must return
    … …  
    164164
    165165/**
    166     \brief destroys and cleans up the current entity.
     166  * destroys and cleans up the current entity.
    167167
    168168    this cleans up ressources before the deconstructor is called. for terminating
    … …  
    174174
    175175/**
    176     \brief this displays the load screen
     176  * this displays the load screen
    177177
    178178    it will need some time to load maps or things like that. to inform the user about
    … …  
    184184
    185185/**
    186     \brief undisplay the load screen
     186  * undisplay the load screen
    187187
    188188    the load process has terminated, you now can release the load screen and start this

  • orxonox/trunk/src/story_entities/story_entity.h

    r4597 r4836  
    11/*!
    22    \file story_entity.h
    3     \brief holds the base class of everything that is playable - that is part of the story
     3  * holds the base class of everything that is playable - that is part of the story
    44*/
    55

  • orxonox/trunk/src/story_entities/world.cc

    r4834 r4836  
    7676
    7777/**
    78    \brief private constructor because of singleton
     78 * private constructor because of singleton
    7979*/
    8080WorldInterface::WorldInterface()
    … …  
    8585
    8686/**
    87    \brief public deconstructor
     87 * public deconstructor
    8888*/
    8989WorldInterface::~WorldInterface()
    … …  
    9595
    9696/**
    97    \brief gets the singleton instance
    98    \returns singleton instance
     97 * gets the singleton instance
     98 * @returns singleton instance
    9999*/
    100100WorldInterface* WorldInterface::getInstance()
    … …  
    107107
    108108/**
    109    \brief initializes the interface
    110    \param reference to the world
     109 * initializes the interface
     110 * @param reference to the world
    111111
    112112   if the worldinterface is not initilizes, there wont be any
    … …  
    125125
    126126/**
    127    \brief gets the entity list from the world
    128    \return entity list
     127 * gets the entity list from the world
     128 * @return entity list
    129129*/
    130130tList<WorldEntity>* WorldInterface::getEntityList()
    … …  
    147147
    148148/**
    149     \brief create a new World
     149  * create a new World
    150150
    151151    This creates a new empty world!
    … …  
    159159
    160160/**
    161    \brief creates a new World...
    162    \param worldID with this ID
     161 * creates a new World...
     162 * @param worldID with this ID
    163163*/
    164164World::World (int worldID)
    … …  
    169169
    170170/**
    171     \brief remove the World from memory
     171  * remove the World from memory
    172172
    173173    delete everything explicitly, that isn't contained in the parenting tree!
    … …  
    207207
    208208/**
    209    \brief initializes the world.
     209 * initializes the world.
    210210
    211211   set all stuff here that is world generic and does not use to much memory
    … …  
    245245
    246246/**
    247    \brief this is executed before load
     247 * this is executed before load
    248248
    249249   since the load function sometimes needs data, that has been init before
    … …  
    277277
    278278/**
    279    \brief loads the World by initializing all resources, and set their default values.
     279 * loads the World by initializing all resources, and set their default values.
    280280*/
    281281ErrorMessage World::load()
    … …  
    376376          if( element->Value() != NULL && !strcmp( element->Value(), "Terrain")) terrain = (Terrain*) created;
    377377          element = element->NextSiblingElement();
    378           glmis->step(); //! \todo temporary
     378          glmis->step(); //! @todo temporary
    379379        }
    380380      PRINTF(4)("Done loading WorldEntities\n");
    … …  
    509509
    510510/**
    511    \brief loads the debug world: only for experimental stuff
     511 * loads the debug world: only for experimental stuff
    512512*/
    513513void World::loadDebugWorld(int worldID)
    … …  
    679679
    680680/**
    681    \brief initializes a new World shortly before start
     681 * initializes a new World shortly before start
    682682
    683683   this is the function, that will be loaded shortly before the world is
    … …  
    692692
    693693/**
    694    \brief starts the World
     694 * starts the World
    695695*/
    696696ErrorMessage World::start()
    … …  
    703703
    704704/**
    705    \brief stops the world.
     705 * stops the world.
    706706
    707707   This happens, when the player decides to end the Level.
    … …  
    714714
    715715/**
    716    \brief pauses the Game
     716 * pauses the Game
    717717*/
    718718ErrorMessage World::pause()
    … …  
    722722
    723723/**
    724    \brief ends the pause Phase
     724 * ends the pause Phase
    725725*/
    726726ErrorMessage World::resume()
    … …  
    730730
    731731/**
    732    \brief destroys the World
     732 * destroys the World
    733733*/
    734734ErrorMessage World::destroy()
    … …  
    738738
    739739/**
    740    \brief shows the loading screen
     740 * shows the loading screen
    741741*/
    742742void World::displayLoadScreen ()
    … …  
    752752
    753753/**
    754    \brief removes the loadscreen, and changes over to the game
    755 
    756    \todo take out the delay
     754 * removes the loadscreen, and changes over to the game
     755
     756   @todo take out the delay
    757757*/
    758758void World::releaseLoadScreen ()
    … …  
    766766
    767767/**
    768    \brief gets the list of entities from the world
    769    \returns entity list
     768 * gets the list of entities from the world
     769 * @returns entity list
    770770*/
    771771tList<WorldEntity>* World::getEntities()
    … …  
    776776
    777777/**
    778    \brief this returns the current game time
    779    \returns elapsed game time
     778 * this returns the current game time
     779 * @returns elapsed game time
    780780*/
    781781double World::getGameTime()
    … …  
    786786
    787787/**
    788     \brief checks for collisions
     788  * checks for collisions
    789789
    790790    This method runs through all WorldEntities known to the world and checks for collisions
    … …  
    829829
    830830/**
    831     \brief runs through all entities calling their draw() methods
     831  * runs through all entities calling their draw() methods
    832832*/
    833833void World::draw ()
    … …  
    858858
    859859/**
    860    \brief function to put your own debug stuff into it. it can display informations about
     860 * function to put your own debug stuff into it. it can display informations about
    861861   the current class/procedure
    862862*/
    … …  
    936936  this->lastFrame = SDL_GetTicks ();
    937937  PRINTF(3)("World::mainLoop() - Entering main loop\n");
    938   while( !this->bQuitOrxonox && !this->bQuitCurrentGame) /* \todo implement pause */
     938  while( !this->bQuitOrxonox && !this->bQuitCurrentGame) /* @todo implement pause */
    939939    {
    940940      ++this->cycle;
    … …  
    956956
    957957      //      for( int i = 0; i < 5000000; i++) {}
    958       /* \todo this is to slow down the program for openGl Software emulator computers, reimplement*/
     958      /* @todo this is to slow down the program for openGl Software emulator computers, reimplement*/
    959959    }
    960960  PRINTF(3)("World::mainLoop() - Exiting the main loop\n");
    … …  
    963963
    964964/**
    965    \brief synchronize local data with remote data
     965 * synchronize local data with remote data
    966966*/
    967967void World::synchronize ()
    … …  
    973973
    974974/**
    975    \brief run all input processing
     975 * run all input processing
    976976
    977977   the command node is the central input event dispatcher. the node uses the even-queue from
    … …  
    991991
    992992/**
    993    \brief advance the timeline
     993 * advance the timeline
    994994
    995995   this calculates the time used to process one frame (with all input handling, drawing, etc)
    … …  
    10491049         but since we like the things not too complicated we got it this way around
    10501050         until there is need or time to do it the other way around.
    1051          \todo: GraphicsEngine ticks world: separation of processes and data...
     1051         @todo: GraphicsEngine ticks world: separation of processes and data...
    10521052
    10531053        bensch: in my opinion the GraphicsEngine could draw the world, but not tick it,
    … …  
    10611061
    10621062/**
    1063    \brief this function gives the world a consistant state
     1063 * this function gives the world a consistant state
    10641064
    10651065   after ticking (updating the world state) this will give a constistant
    … …  
    10761076
    10771077/**
    1078    \brief render the current frame
     1078 * render the current frame
    10791079
    10801080   clear all buffers and draw the world
    … …  
    10891089  this->draw();
    10901090  // draw HUD
    1091   /* \todo draw HUD */
     1091  /* @todo draw HUD */
    10921092  // flip buffers
    10931093  GraphicsEngine::swapBuffers();
    … …  
    10981098
    10991099/**
    1100    \brief add and spawn a new entity to this world
    1101    \param entity to be added
     1100 * add and spawn a new entity to this world
     1101 * @param entity to be added
    11021102*/
    11031103void World::spawn(WorldEntity* entity)
    … …  
    11091109
    11101110/**
    1111    \brief add and spawn a new entity to this world
    1112    \param entity to be added
    1113    \param absCoor At what coordinates to add this entity.
    1114    \param absDir In which direction should it look.
     1111 * add and spawn a new entity to this world
     1112 * @param entity to be added
     1113 * @param absCoor At what coordinates to add this entity.
     1114 * @param absDir In which direction should it look.
    11151115*/
    11161116void World::spawn(WorldEntity* entity, Vector* absCoor, Quaternion* absDir)
    … …  
    11261126
    11271127/**
    1128    \brief add and spawn a new entity to this world
    1129    \param entity to be added
    1130    \param entity to be added to (PNode)
    1131    \param At what relative  coordinates to add this entity.
    1132    \param In which relative direction should it look.
     1128 * add and spawn a new entity to this world
     1129 * @param entity to be added
     1130 * @param entity to be added to (PNode)
     1131 * @param At what relative  coordinates to add this entity.
     1132 * @param In which relative direction should it look.
    11331133*/
    11341134void World::spawn(WorldEntity* entity, PNode* parentNode,
    … …  
    11531153/**
    11541154  \brief commands that the world must catch
    1155   \returns false if not used by the world
     1155  @returns false if not used by the world
    11561156*/
    11571157bool World::command(Command* cmd)

  • orxonox/trunk/src/story_entities/world.h

    r4822 r4836  
    11/*!
    22    \file world.h
    3     \brief Holds and manages all game data
     3  * Holds and manages all game data
    44*/
    55
    … …  
    115115  PNode* nullParent;                  //!< The zero-point, that everything has as its parent.
    116116  Camera* localCamera;                //!< The current Camera
    117   WorldEntity* sky;                   //!< The Environmental Heaven of orxonox \todo insert this to environment insted
     117  WorldEntity* sky;                   //!< The Environmental Heaven of orxonox @todo insert this to environment insted
    118118  Terrain* terrain;                   //!< The Terrain of the World.
    119119
    120   GLuint objectList;                  //!< temporary: \todo this will be ereased soon
     120  GLuint objectList;                  //!< temporary: @todo this will be ereased soon
    121121  tList<WorldEntity>* entities;       //!< A template List of all entities. Every moving thing should be included here, and world automatically updates them.
    122122  Player* localPlayer;                //!< The Player, you fly through the level.

  • orxonox/trunk/src/subprojects/benchmark.h

    r4746 r4836  
    11/*!
    22    \file benchmark.h
    3     \brief benchmark functions
     3  * benchmark functions
    44*/
    55

  • orxonox/trunk/src/util/animation/animation.cc

    r4746 r4836  
    2121
    2222/**
    23    \brief creates a new Animation
     23 * creates a new Animation
    2424
    2525   This also adds the Animation automatically to the AnimationPlayer's list
    … …  
    4444
    4545/**
    46    \brief destructs the Animation
     46 * destructs the Animation
    4747
    4848   this also takes the animation out of the AnimationPlayer's list (if it is there)
    … …  
    5454
    5555/**
    56    \brief tells the AnimationPlayer, that we do not wish to  handle this animation
     56 * tells the AnimationPlayer, that we do not wish to  handle this animation
    5757   automatically.
    5858
    … …  
    6666
    6767/**
    68    \brief Sets the infinitymode
    69    \param postInfinity How the Animation should advance after the last Keyframe
     68 * Sets the infinitymode
     69 * @param postInfinity How the Animation should advance after the last Keyframe
    7070*/
    7171void Animation::setInfinity(ANIM_INFINITY postInfinity)
    … …  
    7575
    7676/**
    77    \brief handles the Animation if it gets out of boundraries eg. if animation is finished.
     77 * handles the Animation if it gets out of boundraries eg. if animation is finished.
    7878*/
    7979void Animation::handleInfinity()
    … …  
    9999
    100100/**
    101    \brief plays the animation back from the current Time forward
     101 * plays the animation back from the current Time forward
    102102*/
    103103void Animation::play()
    … …  
    108108
    109109/**
    110    \brief plays the Next n keyframes
    111    \param n the Count of keyFrames to play.
     110 * plays the Next n keyframes
     111 * @param n the Count of keyFrames to play.
    112112*/
    113113void Animation::playNextKeyframes(int n)
    … …  
    118118
    119119/**
    120    \brief Stops the animation. eg. pause(); rewind();
     120 * Stops the animation. eg. pause(); rewind();
    121121*/
    122122void Animation::stop()
    … …  
    130130
    131131/**
    132    \brief Pauses the animation. Stays at the current Time
     132 * Pauses the animation. Stays at the current Time
    133133*/
    134134void Animation::pause()
    … …  
    138138
    139139/**
    140    \brief replays the animation, eg. rewind();play();
     140 * replays the animation, eg. rewind();play();
    141141*/
    142142void Animation::replay()

  • orxonox/trunk/src/util/animation/animation.h

    r4746 r4836  
    1616//! An enumerator of Functions to describe the flow of the Animation
    1717/**
    18    \todo check with Patrick it of
     18   @todo check with Patrick it of
    1919
    2020   description in speed to the next keyframe:
    … …  
    8888  virtual void rewind() = 0;
    8989
    90   /** \brief A virtual function that ticks the animation \param dt the time passed */
     90  /** \brief A virtual function that ticks the animation @param dt the time passed */
    9191  virtual void tick(float dt) = 0;
    9292
    93   /** \returns the BaseObject, this animation operates on */
     93  /** @returns the BaseObject, this animation operates on */
    9494  BaseObject* getBaseObject() const { return this->baseObject; };
    9595
    96   /** \returns if the Animation should be deleted */
     96  /** @returns if the Animation should be deleted */
    9797  inline bool ifDelete() { return bDelete; };
    9898
    … …  
    124124 public:
    125125  inline aTest() { last = 0.0;}
    126   /** \brief a little debug information to show the results of this class \param f new value */
     126  /** \brief a little debug information to show the results of this class @param f new value */
    127127  inline void littleDebug(float f) {  diff = f - last; printf("f=%f, diff=%f\n", f,diff); last = f;}
    128128 private:

  • orxonox/trunk/src/util/animation/animation3d.cc

    r4746 r4836  
    2828
    2929/**
    30    \brief standard constructor
     30 * standard constructor
    3131*/
    3232Animation3D::Animation3D(PNode* object)
    … …  
    5050
    5151/**
    52    \brief standard deconstructor
     52 * standard deconstructor
    5353
    5454   deletes all the Keyframes
    … …  
    6969
    7070/**
    71    \brief rewinds the Animation to the beginning (first KeyFrame and time == 0)
     71 * rewinds the Animation to the beginning (first KeyFrame and time == 0)
    7272*/
    7373void Animation3D::rewind()
    … …  
    8181
    8282/**
    83    \brief Appends a new Keyframe
    84    \param position The position of the new Keyframe
    85    \param direction The direction of the new Keyframe.
    86    \param duration The duration from the new KeyFrame to the next one
    87    \param animFuncMov The function to animate position between this keyFrame and the next one
    88    \param animFuncRot The function to animate rotation between this keyFrame and the next one
     83 * Appends a new Keyframe
     84 * @param position The position of the new Keyframe
     85 * @param direction The direction of the new Keyframe.
     86 * @param duration The duration from the new KeyFrame to the next one
     87 * @param animFuncMov The function to animate position between this keyFrame and the next one
     88 * @param animFuncRot The function to animate rotation between this keyFrame and the next one
    8989*/
    9090void Animation3D::addKeyFrame(Vector position, Quaternion direction, float duration,
    … …  
    130130
    131131/**
    132    \brief ticks the Animation
    133    \param dt how much time to tick
     132 * ticks the Animation
     133 * @param dt how much time to tick
    134134*/
    135135void Animation3D::tick(float dt)
    … …  
    167167
    168168/**
    169    \brief Sets The kind of movment Animation between this keyframe and the next one
    170    \param animFuncMov: The Type of Animation to set
     169 * Sets The kind of movment Animation between this keyframe and the next one
     170 * @param animFuncMov: The Type of Animation to set
    171171*/
    172172void Animation3D::setAnimFuncMov(ANIM_FUNCTION animFuncMov)
    … …  
    216216
    217217/**
    218    \brief stays at the value of the currentKeyFrame
    219    \param timePassed The time passed since this Keyframe began
     218 * stays at the value of the currentKeyFrame
     219 * @param timePassed The time passed since this Keyframe began
    220220*/
    221221void Animation3D::mConstant(float timePassed) const
    … …  
    232232
    233233/**
    234    \brief linear interpolation between this keyframe and the next one
    235    \param timePassed The time passed since this Keyframe began
    236 
    237    \todo implement also do this for direction
     234 * linear interpolation between this keyframe and the next one
     235 * @param timePassed The time passed since this Keyframe began
     236
     237   @todo implement also do this for direction
    238238*/
    239239void Animation3D::mLinear(float timePassed) const
    … …  
    245245
    246246/**
    247    \brief a Sinusodial Interpolation between this keyframe and the next one
    248    \param timePassed The time passed since this Keyframe began
    249 
    250    \todo implement
     247 * a Sinusodial Interpolation between this keyframe and the next one
     248 * @param timePassed The time passed since this Keyframe began
     249
     250   @todo implement
    251251*/
    252252void Animation3D::mSine(float timePassed) const
    … …  
    264264
    265265/**
    266    \brief a cosine interpolation between this keyframe and the next one
    267    \param timePassed The time passed since this Keyframe began
    268 
    269    \todo implement
     266 * a cosine interpolation between this keyframe and the next one
     267 * @param timePassed The time passed since this Keyframe began
     268
     269   @todo implement
    270270*/
    271271void Animation3D::mCosine(float timePassed) const
    … …  
    287287
    288288/**
    289    \brief an exponential interpolation between this keyframe and the next one
    290    \param timePassed The time passed since this Keyframe began
     289 * an exponential interpolation between this keyframe and the next one
     290 * @param timePassed The time passed since this Keyframe began
    291291*/
    292292void Animation3D::mExp(float timePassed) const
    … …  
    297297
    298298/**
    299    \brief a negative exponential interpolation between this keyframe and the next one
    300    \param timePassed The time passed since this Keyframe began
     299 * a negative exponential interpolation between this keyframe and the next one
     300 * @param timePassed The time passed since this Keyframe began
    301301*/
    302302void Animation3D::mNegExp(float timePassed) const
    … …  
    316316
    317317/**
    318    \brief a quadratic interpolation between this keyframe and the next one
    319    \param timePassed The time passed since this Keyframe began
    320 
    321    \todo implement
     318 * a quadratic interpolation between this keyframe and the next one
     319 * @param timePassed The time passed since this Keyframe began
     320
     321   @todo implement
    322322*/
    323323void Animation3D::mQuadratic(float timePassed) const
    … …  
    328328
    329329/**
    330    \brief some random animation (fluctuating)
    331    \param timePassed The time passed since this Keyframe began
     330 * some random animation (fluctuating)
     331 * @param timePassed The time passed since this Keyframe began
    332332*/
    333333void Animation3D::mRandom(float timePassed) const
    … …  
    346346
    347347/**
    348    \brief Sets The kind of rotation Animation between this keyframe and the next one
    349    \param animFuncRot: The Type of Animation to set
     348 * Sets The kind of rotation Animation between this keyframe and the next one
     349 * @param animFuncRot: The Type of Animation to set
    350350*/
    351351void Animation3D::setAnimFuncRot(ANIM_FUNCTION animFuncRot)
    … …  
    385385
    386386/**
    387    \brief stays at the value of the currentKeyFrame
    388    \param timePassed The time passed since this Keyframe began
     387 * stays at the value of the currentKeyFrame
     388 * @param timePassed The time passed since this Keyframe began
    389389*/
    390390void Animation3D::rConstant(float timePassed) const
    … …  
    394394
    395395/**
    396    \brief linear interpolation between this keyframe and the next one
    397    \param timePassed The time passed since this Keyframe began
    398 
    399    \todo implement also do this for direction
     396 * linear interpolation between this keyframe and the next one
     397 * @param timePassed The time passed since this Keyframe began
     398
     399   @todo implement also do this for direction
    400400*/
    401401void Animation3D::rLinear(float timePassed) const
    … …  
    407407
    408408/**
    409    \brief a Sinusodial Interpolation between this keyframe and the next one
    410    \param timePassed The time passed since this Keyframe began
    411 
    412    \todo implement
     409 * a Sinusodial Interpolation between this keyframe and the next one
     410 * @param timePassed The time passed since this Keyframe began
     411
     412   @todo implement
    413413*/
    414414void Animation3D::rSine(float timePassed) const
    … …  
    427427
    428428/**
    429    \brief a cosine interpolation between this keyframe and the next one
    430    \param timePassed The time passed since this Keyframe began
    431 
    432    \todo implement
     429 * a cosine interpolation between this keyframe and the next one
     430 * @param timePassed The time passed since this Keyframe began
     431
     432   @todo implement
    433433*/
    434434void Animation3D::rCosine(float timePassed) const
    … …  
    443443
    444444/**
    445    \brief an exponential interpolation between this keyframe and the next one
    446    \param timePassed The time passed since this Keyframe began
     445 * an exponential interpolation between this keyframe and the next one
     446 * @param timePassed The time passed since this Keyframe began
    447447*/
    448448void Animation3D::rExp(float timePassed) const
    … …  
    452452
    453453/**
    454    \brief a negative exponential interpolation between this keyframe and the next one
    455    \param timePassed The time passed since this Keyframe began
     454 * a negative exponential interpolation between this keyframe and the next one
     455 * @param timePassed The time passed since this Keyframe began
    456456*/
    457457void Animation3D::rNegExp(float timePassed) const
    … …  
    465465
    466466/**
    467    \brief a quadratic interpolation between this keyframe and the next one
    468    \param timePassed The time passed since this Keyframe began
    469 
    470    \todo implement
     467 * a quadratic interpolation between this keyframe and the next one
     468 * @param timePassed The time passed since this Keyframe began
     469
     470   @todo implement
    471471*/
    472472void Animation3D::rQuadratic(float timePassed) const
    … …  
    476476
    477477/**
    478    \brief some random animation (fluctuating)
    479    \param timePassed The time passed since this Keyframe began
     478 * some random animation (fluctuating)
     479 * @param timePassed The time passed since this Keyframe began
    480480*/
    481481void Animation3D::rRandom(float timePassed) const

  • orxonox/trunk/src/util/animation/animation_player.cc

    r4746 r4836  
    2424
    2525/**
    26    \brief standard constructor
     26 * standard constructor
    2727*/
    2828AnimationPlayer::AnimationPlayer ()
    … …  
    3636
    3737/**
    38    \brief the singleton reference to this class
     38 * the singleton reference to this class
    3939*/
    4040AnimationPlayer* AnimationPlayer::singletonRef = NULL;
    4141
    4242/**
    43    \brief standard deconstructor
     43 * standard deconstructor
    4444
    4545   !! DANGER !! when unloading the AnimationPlayer no other Function
    … …  
    5858
    5959/**
    60    \brief adds an Animation to the AnimationList.
    61    \param animation the Animation to handle
     60 * adds an Animation to the AnimationList.
     61 * @param animation the Animation to handle
    6262
    6363   when adding a Animation the Animation will too be deleted when
    … …  
    7171
    7272/**
    73    \brief removes an Animation from the Animation List, WITHOUT deleting it.
    74    \param animation the Anmination to remove from the List
     73 * removes an Animation from the Animation List, WITHOUT deleting it.
     74 * @param animation the Anmination to remove from the List
    7575*/
    7676void AnimationPlayer::removeAnimation(Animation* animation)
    … …  
    8080
    8181/**
    82    \brief empties the list AND deletes all the Animations
     82 * empties the list AND deletes all the Animations
    8383*/
    8484void AnimationPlayer::flush()
    … …  
    100100
    101101/**
    102    \brief Ticks all the animations in animationList
    103    \param timePassed the time passed since the last tick.
     102 * Ticks all the animations in animationList
     103 * @param timePassed the time passed since the last tick.
    104104*/
    105105void AnimationPlayer::tick(float timePassed)
    … …  
    124124}
    125125/**
    126    \brief starts playing the AnimationPlayer
     126 * starts playing the AnimationPlayer
    127127*/
    128128void AnimationPlayer::play()
    … …  
    132132
    133133/**
    134    \brief pauses playing of the AnimationPlayer
     134 * pauses playing of the AnimationPlayer
    135135*/
    136136void AnimationPlayer::pause()
    … …  
    140140
    141141/**
    142    \returns the animation from a certain baseobject
     142 * @returns the animation from a certain baseobject
    143143   if multiple are found, it just retruns the first one
    144144   if none is found it returns NULL
    … …  
    164164
    165165/**
    166    \brief Outputs some nice debug-information
     166 * Outputs some nice debug-information
    167167*/
    168168void AnimationPlayer::debug()

  • orxonox/trunk/src/util/animation/animation_player.h

    r4746 r4836  
    2929
    3030 public:
    31   /** \returns a Pointer to the only object of this Class */
     31  /** @returns a Pointer to the only object of this Class */
    3232  inline static AnimationPlayer* getInstance() { if (!singletonRef) singletonRef = new AnimationPlayer();  return singletonRef; };
    3333

  • orxonox/trunk/src/util/animation/t_animation.h

    r4746 r4836  
    7777
    7878/**
    79    \brief standard constructor
     79 * standard constructor
    8080*/
    8181template<class T>
    … …  
    9999
    100100/**
    101    \brief standard deconstructor
     101 * standard deconstructor
    102102
    103103   deletes all the Keyframes
    … …  
    119119
    120120/**
    121    \brief rewinds the Animation to the beginning (first KeyFrame and time == 0)
     121 * rewinds the Animation to the beginning (first KeyFrame and time == 0)
    122122*/
    123123template<class T>
    … …  
    131131
    132132/**
    133    \brief sets the Function we want to animate
    134    \param object from what object do we want to animate
    135    \param funcToAnim which function
     133 * sets the Function we want to animate
     134 * @param object from what object do we want to animate
     135 * @param funcToAnim which function
    136136*/
    137137template<class T>
    … …  
    143143
    144144/**
    145    \brief Appends a new Keyframe
    146    \param value the value of the new KeyFrame
    147    \param duration The duration from the new KeyFrame to the next one
    148    \param animFunc The function to animate between this keyFrame and the next one
     145 * Appends a new Keyframe
     146 * @param value the value of the new KeyFrame
     147 * @param duration The duration from the new KeyFrame to the next one
     148 * @param animFunc The function to animate between this keyFrame and the next one
    149149*/
    150150template<class T>
    … …  
    181181
    182182/**
    183    \brief ticks the Animation
    184    \param dt how much time to tick
     183 * ticks the Animation
     184 * @param dt how much time to tick
    185185*/
    186186template<class T>
    … …  
    217217
    218218/**
    219    \brief Sets The kind of Animation between this keyframe and the next one
    220    \param animFunc The Type of Animation to set
     219 * Sets The kind of Animation between this keyframe and the next one
     220 * @param animFunc The Type of Animation to set
    221221*/
    222222template<class T>
    … …  
    259259// animation functions
    260260/**
    261    \brief stays at the value of the currentKeyFrame
    262    \param timePassed The time passed since this Keyframe began
     261 * stays at the value of the currentKeyFrame
     262 * @param timePassed The time passed since this Keyframe began
    263263*/
    264264template<class T>
    … …  
    269269
    270270/**
    271    \brief linear interpolation between this keyframe and the next one
    272    \param timePassed The time passed since this Keyframe began
     271 * linear interpolation between this keyframe and the next one
     272 * @param timePassed The time passed since this Keyframe began
    273273*/
    274274template<class T>
    … …  
    280280
    281281/**
    282    \brief a Sinusodial Interpolation between this keyframe and the next one
    283    \param timePassed The time passed since this Keyframe began
     282 * a Sinusodial Interpolation between this keyframe and the next one
     283 * @param timePassed The time passed since this Keyframe began
    284284*/
    285285template<class T>
    … …  
    299299
    300300/**
    301    \brief a cosine interpolation between this keyframe and the next one
    302    \param timePassed The time passed since this Keyframe began
     301 * a cosine interpolation between this keyframe and the next one
     302 * @param timePassed The time passed since this Keyframe began
    303303*/
    304304template<class T>
    … …  
    311311
    312312/**
    313    \brief an exponential interpolation between this keyframe and the next one
    314    \param timePassed The time passed since this Keyframe began
     313 * an exponential interpolation between this keyframe and the next one
     314 * @param timePassed The time passed since this Keyframe began
    315315*/
    316316template<class T>
    … …  
    322322
    323323/**
    324    \brief a negative exponential interpolation between this keyframe and the next one
    325    \param timePassed The time passed since this Keyframe began
     324 * a negative exponential interpolation between this keyframe and the next one
     325 * @param timePassed The time passed since this Keyframe began
    326326*/
    327327template<class T>
    … …  
    334334
    335335/**
    336    \brief a quadratic interpolation between this keyframe and the next one
    337    \param timePassed The time passed since this Keyframe began
     336 * a quadratic interpolation between this keyframe and the next one
     337 * @param timePassed The time passed since this Keyframe began
    338338*/
    339339template<class T>
    … …  
    344344
    345345/**
    346    \brief some random animation (fluctuating)
    347    \param timePassed The time passed since this Keyframe began
     346 * some random animation (fluctuating)
     347 * @param timePassed The time passed since this Keyframe began
    348348*/
    349349template<class T>

  • orxonox/trunk/src/util/garbage_collector.cc

    r4652 r4836  
    3131
    3232/**
    33    \brief standard constructor
     33 * standard constructor
    3434*/
    3535GarbageCollector::GarbageCollector ()
    … …  
    4444
    4545/**
    46    \brief standard deconstructor
     46 * standard deconstructor
    4747*/
    4848GarbageCollector::~GarbageCollector ()
    … …  
    5252
    5353/**
    54    \brief this sets the collection delay
    55    \param delay: the delay
     54 * this sets the collection delay
     55 * @param delay: the delay
    5656
    5757   after this delay, the garbage collector starts its work and begins to collect unused object
    … …  
    6666
    6767/**
    68    \brief this foreces a garbage collection
     68 * this foreces a garbage collection
    6969
    7070   if this function is called, the gc tries to initiate the garbage collection routines. actually
    … …  
    8181
    8282/**
    83    \brief this ticks the GarbageCollector to give it the time pulse
    84    \param time: the time passed since last tick
     83 * this ticks the GarbageCollector to give it the time pulse
     84 * @param time: the time passed since last tick
    8585
    8686   like every other tick function eg. worldentity
    … …  
    9393
    9494/**
    95    \brief this updated the gargabe collection, if the time is ready
     95 * this updated the gargabe collection, if the time is ready
    9696*/
    9797void GarbageCollector::update()

  • orxonox/trunk/src/util/garbage_collector.h

    r4746 r4836  
    1 /*! 
     1/*!
    22    \file garbage_collector.h
    3     \brief Definition of the proto class template, used quickly start work
    4     \todo Example: this shows how to use simply add a Marker that here has to be done something.
     3  * Definition of the proto class template, used quickly start work
     4    @todo Example: this shows how to use simply add a Marker that here has to be done something.
    55
    66    The Protoclass exists, to help you quikly getting the run for how to develop in orxonox.
    … …  
    1616//! this class maintains the garbage collection.
    1717/**
    18    the class is been ticked by the world.cc and goes through the 
     18   the class is been ticked by the world.cc and goes through the
    1919   world_entity list to clean out all unused entities.
    2020*/
    … …  
    2323 public:
    2424  virtual ~GarbageCollector();
    25   /** \returns a Pointer to the only object of this Class */
     25  /** @returns a Pointer to the only object of this Class */
    2626  inline static GarbageCollector* getInstance() { if (!singletonRef) singletonRef = new GarbageCollector();  return singletonRef; };
    2727

  • orxonox/trunk/src/util/loading/factory.cc

    r4739 r4836  
    2626
    2727/**
    28    \brief constructor
     28 * constructor
    2929
    3030   set everything to zero and define factoryName
    … …  
    4444
    4545/**
    46    \brief destructor
     46 * destructor
    4747
    4848   clear the Q
    … …  
    5858
    5959/**
    60    \brief add a Factory to the Factory Queue
    61    \param factory a Factory to be registered
     60 * add a Factory to the Factory Queue
     61 * @param factory a Factory to be registered
    6262*/
    6363void Factory::registerFactory( Factory* factory)

  • orxonox/trunk/src/util/loading/factory.h

    r4746 r4836  
    3333    Creates a factory to a Loadable Class.
    3434    this should be used at the beginning of all the Classes that should be loadable (in the cc-file)
    35   \todo make factoryName a BaseObject-parameter. (else it would be redundant)
     35  @todo make factoryName a BaseObject-parameter. (else it would be redundant)
    3636*/
    3737#define CREATE_FACTORY(CLASS_NAME) tFactory<CLASS_NAME>* global_##CLASS_NAME##_Factory = new tFactory<CLASS_NAME>(#CLASS_NAME)
    … …  
    4848
    4949  static void registerFactory( Factory* factory);
    50   /** \brief sets the Next factory in the list \param nextFactory the next factory */
     50  /** \brief sets the Next factory in the list @param nextFactory the next factory */
    5151  inline void setNext( Factory* nextFactory) { this->next = nextFactory; };
    52   /** \returns the first factory */
     52  /** @returns the first factory */
    5353  static Factory* getFirst() { return Factory::first; };
    54   /** \returns the next factory */
     54  /** @returns the next factory */
    5555  Factory* getNext() const { return this->next; };
    5656
    … …  
    6464
    6565/**
    66    \brief a factory that is able to load any kind of Object
     66 * a factory that is able to load any kind of Object
    6767   (this is a Functor)
    6868*/
    … …  
    7878
    7979/**
    80    \brief construnts a factory with
    81    \param factoryName the name of the factory
     80 * construnts a factory with
     81 * @param factoryName the name of the factory
    8282*/
    8383template<class T>

  • orxonox/trunk/src/util/loading/game_loader.cc

    r4817 r4836  
    3737
    3838/**
    39    \brief simple constructor
     39 * simple constructor
    4040*/
    4141GameLoader::GameLoader ()
    … …  
    4747
    4848/**
    49    \brief simple deconstructor
     49 * simple deconstructor
    5050*/
    5151GameLoader::~GameLoader ()
    … …  
    5959
    6060/**
    61    \brief this class is a singleton class
    62    \returns an instance of itself
     61 * this class is a singleton class
     62 * @returns an instance of itself
    6363
    6464   if you are unsure about singleton classes, check the theory out on the internet :)
    … …  
    7272
    7373/**
    74    \brief initializes the GameLoader
     74 * initializes the GameLoader
    7575*/
    7676ErrorMessage GameLoader::init()
    … …  
    8888
    8989/**
    90    \brief reads a campaign definition file into a campaign class
    91    \param fileName to be loaded
    92    \returns the loaded campaign
     90 * reads a campaign definition file into a campaign class
     91 * @param fileName to be loaded
     92 * @returns the loaded campaign
    9393
    9494   this will interprete the map/campaign files and recursivly load a tree of worlds/campaigns
    … …  
    109109
    110110/**
    111    \brief loads a debug campaign for test purposes only.
    112    \param campaignID the identifier of the campaign.
    113    \returns error message if not able to do so.
     111 * loads a debug campaign for test purposes only.
     112 * @param campaignID the identifier of the campaign.
     113 * @returns error message if not able to do so.
    114114*/
    115115ErrorMessage GameLoader::loadDebugCampaign(Uint32 campaignID)
    … …  
    147147
    148148/**
    149     \brief starts the current entity
    150     \returns error code if this action has caused a error
     149  * starts the current entity
     150  * @returns error code if this action has caused a error
    151151*/
    152152ErrorMessage GameLoader::start()
    … …  
    158158
    159159/**
    160     \brief stops the current entity
    161     \returns error code if this action has caused a error
     160  * stops the current entity
     161  * @returns error code if this action has caused a error
    162162
    163163    ATTENTION: this function shouldn't call other functions, or if so, they must return
    … …  
    175175
    176176/**
    177     \brief pause the current entity
    178     \returns error code if this action has caused a error
     177  * pause the current entity
     178  * @returns error code if this action has caused a error
    179179
    180180    this pauses the current entity or passes this call forth to the running entity.
    … …  
    189189
    190190/**
    191     \brief resumes a pause
    192     \returns error code if this action has caused a error
     191  * resumes a pause
     192  * @returns error code if this action has caused a error
    193193
    194194    this resumess the current entity or passes this call forth to the running entity.
    … …  
    203203
    204204/**
    205    \brief release the mem ATTENTION: not implemented
     205 * release the mem ATTENTION: not implemented
    206206 */
    207207ErrorMessage GameLoader::destroy()
    … …  
    212212
    213213/**
    214    \brief reads a campaign definition file into a campaign class
    215    \param fileName to be loaded
    216    \returns the loaded campaign
     214 * reads a campaign definition file into a campaign class
     215 * @param fileName to be loaded
     216 * @returns the loaded campaign
    217217
    218218   this will interprete the map/campaign files and recursivly load a tree of worlds/campaigns
    … …  
    264264
    265265/**
    266    \brief handle keyboard commands
    267    \param event the event to handle
     266 * handle keyboard commands
     267 * @param event the event to handle
    268268*/
    269269void GameLoader::process(const Event& event)
    … …  
    322322
    323323/**
    324    \brief load a StoryEntity
    325    \param element a XMLElement containing all the needed info
     324 * load a StoryEntity
     325 * @param element a XMLElement containing all the needed info
    326326*/
    327327BaseObject* GameLoader::fabricate(const TiXmlElement* element)

  • orxonox/trunk/src/util/loading/game_loader.h

    r4739 r4836  
    11/*!
    22    \file game_loader.h
    3     \brief loads campaigns, worlds and all other story_entities
     3  * loads campaigns, worlds and all other story_entities
    44*/
    55
    … …  
    5757  void previousLevel();
    5858
    59   /** \brief a world command to send to the GameLoader \param cmd the command */
     59  /** \brief a world command to send to the GameLoader @param cmd the command */
    6060  bool worldCommand(Command* cmd);
    6161  ErrorMessage loadDebugCampaign(Uint32 campaignID);

  • orxonox/trunk/src/util/loading/load_param.cc

    r4746 r4836  
    2222
    2323/**
    24    \param object The object this Parameter is loaded too.
    25    \param root: the XML-element to load this option from.
    26    \param paramName: The name of the parameter loaded.
    27    \param paramCount: how many parameters this loading-function takes
    28    \param multi: if false LoadParam assumes only one occurence of this parameter in root, if true it assumes multiple occurences.
    29    \param ...: the parameter information (1. Parameter, 2. Default Value for the Parameter, ...)
     24 * @param object The object this Parameter is loaded too.
     25 * @param root: the XML-element to load this option from.
     26 * @param paramName: The name of the parameter loaded.
     27 * @param paramCount: how many parameters this loading-function takes
     28 * @param multi: if false LoadParam assumes only one occurence of this parameter in root, if true it assumes multiple occurences.
     29 * @param ...: the parameter information (1. Parameter, 2. Default Value for the Parameter, ...)
    3030*/
    3131BaseLoadParam::BaseLoadParam(const TiXmlElement* root, BaseObject* object, const char* paramName,
    … …  
    152152
    153153/**
    154    \param descriptionText The text to set as a description for this Parameter
    155    \returns a pointer to itself.
     154 * @param descriptionText The text to set as a description for this Parameter
     155 * @returns a pointer to itself.
    156156*/
    157157BaseLoadParam* BaseLoadParam::describe(const char* descriptionText)
    … …  
    165165
    166166/**
    167    \param paramName the name of the parameter to load
     167 * @param paramName the name of the parameter to load
    168168*/
    169169LoadParamDescription::LoadParamDescription(const char* paramName)
    … …  
    177177
    178178/**
    179    \brief removes all the alocated memory
     179 * removes all the alocated memory
    180180*/
    181181LoadParamDescription::~LoadParamDescription()
    … …  
    197197
    198198/**
    199    \param descriptionText The text to set as a description for this Parameter
     199 * @param descriptionText The text to set as a description for this Parameter
    200200*/
    201201void LoadParamDescription::setDescription(const char* descriptionText)
    … …  
    206206
    207207/**
    208    \brief prints out this parameter, its input method and the description (if availiable)
     208 * prints out this parameter, its input method and the description (if availiable)
    209209*/
    210210void LoadParamDescription::print() const
    … …  
    243243
    244244/**
    245    \brief A list, that holds all the classes that are loadable (classes not objects!!)
     245 * A list, that holds all the classes that are loadable (classes not objects!!)
    246246*/
    247247tList<LoadClassDescription>* LoadClassDescription::classList = new tList<LoadClassDescription>;
    248248
    249249/**
    250    \brief if the description of Parameters should be executed
     250 * if the description of Parameters should be executed
    251251*/
    252252bool LoadClassDescription::parametersDescription = true;
    253253
    254254/**
    255    \param className the name of the class to be loadable
     255 * @param className the name of the class to be loadable
    256256*/
    257257LoadClassDescription::LoadClassDescription(const char* className)
    … …  
    266266
    267267/**
    268    \brief deletes a classDescription (deletes all the parameterDescriptions as well
     268 * deletes a classDescription (deletes all the parameterDescriptions as well
    269269*/
    270270LoadClassDescription::~LoadClassDescription()
    … …  
    283283
    284284/**
    285    \brief adds a class to the list of loadable classes
    286    \param className The name of the class to add
     285 * adds a class to the list of loadable classes
     286 * @param className The name of the class to add
    287287
    288288   this function searches for the className string, and if found just returns the appropriate Class.
    … …  
    308308
    309309/**
    310    \brief does the same as addClass(const char* className), but with params
    311    \param paramName the name of the parameter to add.
     310 * does the same as addClass(const char* className), but with params
     311 * @param paramName the name of the parameter to add.
    312312*/
    313313LoadParamDescription* LoadClassDescription::addParam(const char* paramName)
    … …  
    331331
    332332/**
    333    \brief prints out all loadable Classes, and their parameters
     333 * prints out all loadable Classes, and their parameters
    334334*/
    335335void LoadClassDescription::printAll(const char* fileName)
    … …  
    361361
    362362/**
    363    \param root: The XML-element to grab a parameter from
    364    \param parameterName: the parameter to grab
    365    \returns the Value of the parameter if found, NULL otherwise
     363 * @param root: The XML-element to grab a parameter from
     364 * @param parameterName: the parameter to grab
     365 * @returns the Value of the parameter if found, NULL otherwise
    366366*/
    367367const char* grabParameter(const TiXmlElement* root, const char* parameterName)

  • orxonox/trunk/src/util/loading/load_param.h

    r4834 r4836  
    1616/*!
    1717    \file load_param.h
    18     \brief A Class and macro-functions, that makes our lives easy to load-in parameters
     18  * A Class and macro-functions, that makes our lives easy to load-in parameters
    1919*/
    2020
    … …  
    111111// 1. TYPE
    112112/**
    113    \brief a Macro to easily implement many different Constructors for the LoadParam-Class with 1 argument
    114    \param type1 The type of the first functionParameter
     113 * a Macro to easily implement many different Constructors for the LoadParam-Class with 1 argument
     114 * @param type1 The type of the first functionParameter
    115115*/
    116116#define LoadParam1(type1) \
    … …  
    128128// 2. TYPES
    129129/**
    130    \brief a Macro to easily implement many different Constructors for the LoadParam-Class with 2 arguments
    131    \param type1 The type of the first functionParameter
    132    \param type2 The type of the second functionParameter
     130 * a Macro to easily implement many different Constructors for the LoadParam-Class with 2 arguments
     131 * @param type1 The type of the first functionParameter
     132 * @param type2 The type of the second functionParameter
    133133*/
    134134#define LoadParam2(type1, type2) \
    … …  
    153153// 3. TYPES
    154154/**
    155    \brief a Macro to easily implement many different Constructors for the LoadParam-Class with 3 arguments
    156    \param type1 The type of the first functionParameter
    157    \param type2 The type of the second functionParameter
    158    \param type3 The type of the third functionParameter
     155 * a Macro to easily implement many different Constructors for the LoadParam-Class with 3 arguments
     156 * @param type1 The type of the first functionParameter
     157 * @param type2 The type of the second functionParameter
     158 * @param type3 The type of the third functionParameter
    159159*/
    160160#define LoadParam3(type1, type2, type3) \
    … …  
    179179// 4. TYPES
    180180/**
    181    \brief a Macro to easily implement many different Constructors for the LoadParam-Class with 4 arguments
    182    \param type1 The type of the first functionParameter
    183    \param type2 The type of the second functionParameter
    184    \param type3 The type of the third functionParameter
    185    \param type4 The type of the forth functionParameter
     181 * a Macro to easily implement many different Constructors for the LoadParam-Class with 4 arguments
     182 * @param type1 The type of the first functionParameter
     183 * @param type2 The type of the second functionParameter
     184 * @param type3 The type of the third functionParameter
     185 * @param type4 The type of the forth functionParameter
    186186*/
    187187#define LoadParam4(type1, type2, type3, type4) \
    … …  
    208208// 5. TYPES
    209209/**
    210    \brief a Macro to easily implement many different Constructors for the LoadParam-Class with 5 arguments
    211    \param type1 The type of the first functionParameter
    212    \param type2 The type of the second functionParameter
    213    \param type3 The type of the third functionParameter
    214    \param type4 The type of the forth functionParameter
    215    \param type5 The type of the fifth functionParameter
     210 * a Macro to easily implement many different Constructors for the LoadParam-Class with 5 arguments
     211 * @param type1 The type of the first functionParameter
     212 * @param type2 The type of the second functionParameter
     213 * @param type3 The type of the third functionParameter
     214 * @param type4 The type of the forth functionParameter
     215 * @param type5 The type of the fifth functionParameter
    216216*/
    217217#define LoadParam5(type1, type2, type3, type4, type5) \
    … …  
    238238// Pointer TYPE
    239239/**
    240    \brief a Macro to easily implement many different Constructors for the LoadParam-Class with one Pointer argument
    241    \param type1 The type of the Pointer
     240 * a Macro to easily implement many different Constructors for the LoadParam-Class with one Pointer argument
     241 * @param type1 The type of the Pointer
    242242 */
    243243#define LoadParamPT(type1) \
    … …  
    276276
    277277  void setDescription(const char* descriptionText);
    278   /** \returns the descriptionString */
     278  /** @returns the descriptionString */
    279279  const char* getDescription() { return this->description; };
    280280

  • orxonox/trunk/src/util/object_manager.cc

    r4746 r4836  
    2424
    2525/**
    26    \brief standard constructor
     26 * standard constructor
    2727*/
    2828ObjectManager::ObjectManager ()
    … …  
    4040
    4141/**
    42    \brief the singleton reference to this class
     42 * the singleton reference to this class
    4343*/
    4444ObjectManager* ObjectManager::singletonRef = NULL;
    4545
    4646/**
    47    \brief standard deconstructor
     47 * standard deconstructor
    4848*/
    4949ObjectManager::~ObjectManager ()
    … …  
    5353
    5454/**
    55    \brief adds an element to the list of dead objects
    56    \param index: The type of object to add
    57    \param object: pointer to the object at hand
     55 * adds an element to the list of dead objects
     56 * @param index: The type of object to add
     57 * @param object: pointer to the object at hand
    5858*/
    5959void ObjectManager::addToDeadList(int index, BaseObject* object)
    … …  
    6666
    6767/**
    68    \brief resurects an object
    69    \param index: the type of resource to load
    70    \param number: how many of them
     68 * resurects an object
     69 * @param index: the type of resource to load
     70 * @param number: how many of them
    7171
    72    \todo if it is unable to get an object from the deadList, it should create it
     72   @todo if it is unable to get an object from the deadList, it should create it
    7373*/
    7474BaseObject* ObjectManager::getFromDeadList(int index, int number)
    … …  
    9090
    9191/**
    92    \brief outputs some simple debug information about the ObjectManage
     92 * outputs some simple debug information about the ObjectManage
    9393*/
    9494void ObjectManager::debug() const

  • orxonox/trunk/src/util/object_manager.h

    r4746 r4836  
    11/*!
    22    \file object_manager.h
    3     \brief this manager will ceep track of the objects  in the world
     3  * this manager will ceep track of the objects  in the world
    44
    55    This is specially designed to:
    … …  
    4545 public:
    4646  virtual ~ObjectManager();
    47   /** \returns a Pointer to the only object of this Class */
     47  /** @returns a Pointer to the only object of this Class */
    4848  inline static ObjectManager* getInstance() { if (!singletonRef) singletonRef = new ObjectManager();  return singletonRef; };
    4949

  • orxonox/trunk/src/util/resource_manager.cc

    r4746 r4836  
    4747
    4848/**
    49    \brief standard constructor
     49 * standard constructor
    5050*/
    5151ResourceManager::ResourceManager ()
    … …  
    6464
    6565/**
    66    \brief standard destructor
     66 * standard destructor
    6767*/
    6868ResourceManager::~ResourceManager ()
    … …  
    8787
    8888/**
    89    \brief sets the data main directory
    90    \param dataDir the DataDirectory.
     89 * sets the data main directory
     90 * @param dataDir the DataDirectory.
    9191*/
    9292bool ResourceManager::setDataDir(const char* dataDir)
    … …  
    110110
    111111/**
    112    \brief checks for the DataDirectory, by looking if
    113    \param fileInside is inisde??
     112 * checks for the DataDirectory, by looking if
     113 * @param fileInside is inisde??
    114114*/
    115115bool ResourceManager::checkDataDir(const char* fileInside)
    … …  
    131131#ifndef NO_TEXTURES
    132132/**
    133    \brief adds a new Path for Images
    134    \param imageDir The path to insert
    135    \returns true, if the Path was well and injected (or already existent within the list)
     133 * adds a new Path for Images
     134 * @param imageDir The path to insert
     135 * @returns true, if the Path was well and injected (or already existent within the list)
    136136   false otherwise
    137137*/
    … …  
    171171
    172172/**
    173    \brief loads resources
    174    \param fileName: The fileName of the resource to load
    175    \param prio: The ResourcePriority of this resource (will only be increased)
    176    \param param1: an additional option to parse (see the constuctors for more help)
    177    \param param2: an additional option to parse (see the constuctors for more help)
    178    \param param3: an additional option to parse (see the constuctors for more help)
    179    \returns a pointer to a desired Resource.
     173 * loads resources
     174 * @param fileName: The fileName of the resource to load
     175 * @param prio: The ResourcePriority of this resource (will only be increased)
     176 * @param param1: an additional option to parse (see the constuctors for more help)
     177 * @param param2: an additional option to parse (see the constuctors for more help)
     178 * @param param3: an additional option to parse (see the constuctors for more help)
     179 * @returns a pointer to a desired Resource.
    180180*/
    181181void* ResourceManager::load(const char* fileName, ResourcePriority prio, void* param1, void* param2, void* param3)
    … …  
    228228
    229229/**
    230    \brief loads resources
    231    \param fileName: The fileName of the resource to load
    232    \param type: The Type of Resource to load (\see ResourceType)
    233    \param prio: The ResourcePriority of this resource (will only be increased)
    234    \param param1: an additional option to parse (see the constuctors for more help)
    235    \param param2: an additional option to parse (see the constuctors for more help)
    236    \param param3: an additional option to parse (see the constuctors for more help)
    237    \returns a pointer to a desired Resource.
     230 * loads resources
     231 * @param fileName: The fileName of the resource to load
     232 * @param type: The Type of Resource to load (\see ResourceType)
     233 * @param prio: The ResourcePriority of this resource (will only be increased)
     234 * @param param1: an additional option to parse (see the constuctors for more help)
     235 * @param param2: an additional option to parse (see the constuctors for more help)
     236 * @param param3: an additional option to parse (see the constuctors for more help)
     237 * @returns a pointer to a desired Resource.
    238238*/
    239239void* ResourceManager::load(const char* fileName, ResourceType type, ResourcePriority prio,
    … …  
    400400
    401401/**
    402    \brief unloads a Resource
    403    \param pointer: The pointer to free
    404    \param prio: the PriorityLevel to unload this resource
    405    \returns true if successful (pointer found, and deleted), false otherwise
     402 * unloads a Resource
     403 * @param pointer: The pointer to free
     404 * @param prio: the PriorityLevel to unload this resource
     405 * @returns true if successful (pointer found, and deleted), false otherwise
    406406*/
    407407bool ResourceManager::unload(void* pointer, ResourcePriority prio)
    … …  
    419419
    420420/**
    421    \brief unloads a Resource
    422    \param resource: The resource to unloade
    423    \param prio the PriorityLevel to unload this resource
     421 * unloads a Resource
     422 * @param resource: The resource to unloade
     423 * @param prio the PriorityLevel to unload this resource
    424424*/
    425425bool ResourceManager::unload(Resource* resource, ResourcePriority prio)
    … …  
    478478
    479479/**
    480    \brief unloads all alocated Memory of Resources with a pririty lower than prio
    481    \param prio The priority to delete
     480 * unloads all alocated Memory of Resources with a pririty lower than prio
     481 * @param prio The priority to delete
    482482*/
    483483bool ResourceManager::unloadAllByPriority(ResourcePriority prio)
    … …  
    500500
    501501/**
    502    \brief Searches for a Resource by some information
    503    \param fileName: The name to look for
    504    \param type the Type of resource to locate.
    505    \param param1: an additional option to parse (see the constuctors for more help)
    506    \param param2: an additional option to parse (see the constuctors for more help)
    507    \param param3: an additional option to parse (see the constuctors for more help)
    508    \returns a Pointer to the Resource if found, NULL otherwise.
     502 * Searches for a Resource by some information
     503 * @param fileName: The name to look for
     504 * @param type the Type of resource to locate.
     505 * @param param1: an additional option to parse (see the constuctors for more help)
     506 * @param param2: an additional option to parse (see the constuctors for more help)
     507 * @param param3: an additional option to parse (see the constuctors for more help)
     508 * @returns a Pointer to the Resource if found, NULL otherwise.
    509509*/
    510510Resource* ResourceManager::locateResourceByInfo(const char* fileName, ResourceType type,
    … …  
    587587
    588588/**
    589    \brief Searches for a Resource by Pointer
    590    \param pointer the Pointer to search for
    591    \returns a Pointer to the Resource if found, NULL otherwise.
     589 * Searches for a Resource by Pointer
     590 * @param pointer the Pointer to search for
     591 * @returns a Pointer to the Resource if found, NULL otherwise.
    592592*/
    593593Resource* ResourceManager::locateResourceByPointer(const void* pointer)
    … …  
    610610
    611611/**
    612    \brief Checks if it is a Directory
    613    \param directoryName the Directory to check for
    614    \returns true if it is a directory/symlink false otherwise
     612 * Checks if it is a Directory
     613 * @param directoryName the Directory to check for
     614 * @returns true if it is a directory/symlink false otherwise
    615615*/
    616616bool ResourceManager::isDir(const char* directoryName)
    … …  
    657657
    658658/**
    659    \brief Checks if the file is either a Regular file or a Symlink
    660    \param fileName the File to check for
    661    \returns true if it is a regular file/symlink, false otherwise
     659 * Checks if the file is either a Regular file or a Symlink
     660 * @param fileName the File to check for
     661 * @returns true if it is a regular file/symlink, false otherwise
    662662*/
    663663bool ResourceManager::isFile(const char* fileName)
    … …  
    693693
    694694/**
    695    \brief touches a File on the disk (thereby creating it)
    696    \param fileName The file to touch
     695 * touches a File on the disk (thereby creating it)
     696 * @param fileName The file to touch
    697697*/
    698698bool ResourceManager::touchFile(const char* fileName)
    … …  
    713713
    714714/**
    715    \brief deletes a File from disk
    716    \param fileName the File to delete
     715 * deletes a File from disk
     716 * @param fileName the File to delete
    717717*/
    718718bool ResourceManager::deleteFile(const char* fileName)
    … …  
    726726
    727727/**
    728     \param name the Name of the file to check
    729     \returns The name of the file, including the HomeDir
     728  * @param name the Name of the file to check
     729  * @returns The name of the file, including the HomeDir
    730730    IMPORTANT: this has to be deleted from the outside
    731731*/
    … …  
    755755
    756756/**
    757     \param fileName the Name of the File to check
    758     \returns The full name of the file, including the DataDir, and NULL if the file does not exist
     757  * @param fileName the Name of the File to check
     758  * @returns The full name of the file, including the DataDir, and NULL if the file does not exist
    759759    IMPORTANT: this has to be deleted from the outside
    760760*/
    … …  
    778778
    779779/**
    780    \brief outputs debug information about the ResourceManager
     780 * outputs debug information about the ResourceManager
    781781*/
    782782void ResourceManager::debug() const

  • orxonox/trunk/src/util/resource_manager.h

    r4746 r4836  
    11/*!
    22    \file resource_manager.h
    3     \brief The Resource Manager checks if a file/resource is loaded.
     3  * The Resource Manager checks if a file/resource is loaded.
    44
    55    If a file/resource was already loaded the resourceManager will
    … …  
    9999 public:
    100100  virtual ~ResourceManager();
    101   /** \returns a Pointer to the only object of this Class */
     101  /** @returns a Pointer to the only object of this Class */
    102102  inline static ResourceManager* getInstance() { if (!singletonRef) singletonRef = new ResourceManager();  return singletonRef; };
    103103
    104104  bool setDataDir(const char* dataDir);
    105   /** \returns the Name of the data directory */
     105  /** @returns the Name of the data directory */
    106106  inline const char* getDataDir() const {return this->dataDir;}
    107107

  • orxonox/trunk/src/util/state.cc

    r4827 r4836  
    3232
    3333/**
    34    \brief sets camera and target of the current Camera
     34 * sets camera and target of the current Camera
    3535*/
    3636void State::setCamera(const PNode* camera, const PNode* cameraTarget)

  • orxonox/trunk/src/util/state.h

    r4827 r4836  
    11/*!
    22    \file state.h
    3     \brief Definition of the States-singleton Class
     3  * Definition of the States-singleton Class
    44*/
    55

  • orxonox/trunk/src/util/track/pilot_node.cc

    r4597 r4836  
    2626
    2727/**
    28    \brief standard constructor
     28 * standard constructor
    2929*/
    3030PilotNode::PilotNode ()
    … …  
    3939
    4040/**
    41    \brief standard deconstructor
     41 * standard deconstructor
    4242*/
    4343PilotNode::~PilotNode ()
    … …  
    4747
    4848/**
    49     \brief ticks the node
    50     \param time the time about whitch to tick                                           \
     49  * ticks the node
     50  * @param time the time about whitch to tick                                           \
    5151*/
    5252void PilotNode::tick(float time)
    … …  
    5757
    5858/**
    59    \brief action if player moves
    60    \param time the timeslice since the last frame
     59 * action if player moves
     60 * @param time the timeslice since the last frame
    6161*/
    6262void PilotNode::move (float time)
    … …  
    9898
    9999/**
    100    \brief handles events
    101    \param event the event that occured
     100 * handles events
     101 * @param event the event that occured
    102102*/
    103103void PilotNode::process( const Event &event)

  • orxonox/trunk/src/util/track/pilot_node.h

    r4597 r4836  
    11/*!
    22    \file pilot_node.h
    3     \brief Definition of a PilotNode
     3  * Definition of a PilotNode
    44*/
    55

  • orxonox/trunk/src/util/track/track_manager.cc

    r4834 r4836  
    3636
    3737/**
    38    \brief initializes a TrackElement (sets the default values)
     38 * initializes a TrackElement (sets the default values)
    3939*/
    4040TrackElement::TrackElement()
    … …  
    6666
    6767/**
    68     \brief destroys all alocated memory)
    69     \todo eventually when deleting a TrackElement you would not like to delete all its preceding TrackElements
     68  * destroys all alocated memory)
     69    @todo eventually when deleting a TrackElement you would not like to delete all its preceding TrackElements
    7070*/
    7171TrackElement::~TrackElement()
    … …  
    9191
    9292/**
    93    \brief Searches through all the TrackElements for trackID.
    94    \param trackID The ID to search for.
    95    \returns The TrackElement if Found, NULL otherwise.
     93 * Searches through all the TrackElements for trackID.
     94 * @param trackID The ID to search for.
     95 * @returns The TrackElement if Found, NULL otherwise.
    9696*/
    9797TrackElement* TrackElement::findByID(unsigned int trackID)
    … …  
    120120
    121121/**
    122    \brief Searches through all the TrackElements for a trackName
    123    \param trackName The name to search for.
    124    \returns The TrackElement if Found, NULL otherwise.
     122 * Searches through all the TrackElements for a trackName
     123 * @param trackName The name to search for.
     124 * @returns The TrackElement if Found, NULL otherwise.
    125125*/
    126126TrackElement* TrackElement::findByName(const char* trackName)
    … …  
    148148
    149149/**
    150    \brief checks if there are any BackLoops in the Track
    151    \returns true if NO loop was found, false Otherwise
     150 * checks if there are any BackLoops in the Track
     151 * @returns true if NO loop was found, false Otherwise
    152152   You actually have to act on false!!
    153153*/
    … …  
    164164
    165165/**
    166    \brief checks if there are any BackLoops in the Track.
    167    \param trackList A list of stored tracks, to search in.
    168    \returns true if NO loop was found, false Otherwise
     166 * checks if there are any BackLoops in the Track.
     167 * @param trackList A list of stored tracks, to search in.
     168 * @returns true if NO loop was found, false Otherwise
    169169   You actually have to act on false!!
    170170*/
    … …  
    192192
    193193/**
    194    \param childCount which child to return
    195    \returns the n-the children (starting at 0).
     194 * @param childCount which child to return
     195 * @returns the n-the children (starting at 0).
    196196   Be aware, that when the trackElement has no Children, NULL will be returned
    197197*/
    … …  
    214214
    215215/**
    216    \brief prints out debug information about this TrackElement
     216 * prints out debug information about this TrackElement
    217217*/
    218218void TrackElement::debug() const
    … …  
    260260
    261261/**
    262    \brief CONDITION that chooses the first child for the decision (static)
    263    \param nothing Nothing in this function
    264    \returns the chosen child
     262 * CONDITION that chooses the first child for the decision (static)
     263 * @param nothing Nothing in this function
     264 * @returns the chosen child
    265265*/
    266266int TrackElement::lowest(const void* nothing) const
    … …  
    270270
    271271/**
    272    \brief CONDITION that chooses the last child for the decision (static)
    273    \param nothing Nothing in this function
    274    \returns the chosen child
     272 * CONDITION that chooses the last child for the decision (static)
     273 * @param nothing Nothing in this function
     274 * @returns the chosen child
    275275*/
    276276int TrackElement::highest(const void* nothing) const
    … …  
    280280
    281281/**
    282    \brief CONDITION that chooses a random child for the decision (static)
    283    \param nothing Nothing in this function
    284    \returns the chosen child
     282 * CONDITION that chooses a random child for the decision (static)
     283 * @param nothing Nothing in this function
     284 * @returns the chosen child
    285285*/
    286286int TrackElement::random(const void* nothing) const
    … …  
    294294
    295295/**
    296    \brief CONDITION that chooses child 0, if the node(probably Player)
     296 * CONDITION that chooses child 0, if the node(probably Player)
    297297   is left of its parent (z<0)) and 1/right otherwise.
    298    \param node The node to act upon.
    299    \returns the chosen child
     298 * @param node The node to act upon.
     299 * @returns the chosen child
    300300*/
    301301int TrackElement::leftRight(const void* node) const
    … …  
    311311
    312312/**
    313    \brief CONDITION that chooses the child, that has the nearest distance to the node (probably player).
    314    \param node The node to act upon.
    315    \returns the chosen child
     313 * CONDITION that chooses the child, that has the nearest distance to the node (probably player).
     314 * @param node The node to act upon.
     315 * @returns the chosen child
    316316
    317317   This is rather dangerous, because one must carefully set the points on the curve.
    … …  
    354354////////////////////////
    355355/**
    356    \brief standard constructor
     356 * standard constructor
    357357
    358358*/
    … …  
    391391
    392392/**
    393    \brief loads a trackElement from a TiXmlElement
    394    \param root the TiXmlElement to load the Data from
     393 * loads a trackElement from a TiXmlElement
     394 * @param root the TiXmlElement to load the Data from
    395395*/
    396396bool TrackManager::loadParams(const TiXmlElement* root)
    … …  
    449449
    450450/**
    451    \brief standard destructor
     451 * standard destructor
    452452*/
    453453TrackManager::~TrackManager()
    … …  
    469469// INITIALIZE //
    470470/**
    471    \brief reserves Space for childCount children
    472    \param childCount The Count of children to make space for.
    473    \param trackElem The TrackElement to appy this to. (if NULL chose this->currentTrackElement)
     471 * reserves Space for childCount children
     472 * @param childCount The Count of children to make space for.
     473 * @param trackElem The TrackElement to appy this to. (if NULL chose this->currentTrackElement)
    474474*/
    475475void TrackManager::initChildren(unsigned int childCount, TrackElement* trackElem)
    … …  
    513513
    514514/**
    515    \brief Sets the trackID we are working on.
    516    \param trackID the trackID we are working on
     515 * Sets the trackID we are working on.
     516 * @param trackID the trackID we are working on
    517517*/
    518518void TrackManager::workOn(unsigned int trackID)
    … …  
    527527
    528528/**
    529    \brief Sets the TrackElement to work on
    530    \param trackName the Name of the Track to work on
     529 * Sets the TrackElement to work on
     530 * @param trackName the Name of the Track to work on
    531531*/
    532532void TrackManager::workOnS(const char* trackName)
    … …  
    541541
    542542/**
    543    \brief Sets the Type of the Curve
    544    \param curveType The Type to set
    545    \param trackElem the TrackElement that should get a new Curve.
    546 
    547    \brief this will possibly get obsolete during the process.
     543 * Sets the Type of the Curve
     544 * @param curveType The Type to set
     545 * @param trackElem the TrackElement that should get a new Curve.
     546
     547 * this will possibly get obsolete during the process.
    548548*/
    549549void TrackManager::setCurveType(CurveType curveType, TrackElement* trackElem)
    … …  
    564564
    565565/**
    566    \param duration the duration of the TrackElement
     566 * @param duration the duration of the TrackElement
    567567   \see void TrackManager::setDuration(float duration, TrackElement* trackElem)
    568568*/
    … …  
    573573
    574574/**
    575    \brief Sets the duration of the current path in seconds.
    576    \param duration The duration in seconds.
    577    \param trackElem The TrackElement to apply this to.
     575 * Sets the duration of the current path in seconds.
     576 * @param duration The duration in seconds.
     577 * @param trackElem The TrackElement to apply this to.
    578578*/
    579579void TrackManager::setDuration(float duration, TrackElement* trackElem)
    … …  
    587587
    588588/**
    589    \brief adds a point to trackElem
    590    \param x x coord
    591    \param y y coord
    592    \param z z coord
    593    \param trackElem The TrackElement to add the Point to
     589 * adds a point to trackElem
     590 * @param x x coord
     591 * @param y y coord
     592 * @param z z coord
     593 * @param trackElem The TrackElement to add the Point to
    594594*/
    595595void TrackManager::addPoint(float x, float y, float z)
    … …  
    599599
    600600/**
    601    \brief adds a point to trackElem
    602    \param newPoint The point to add.
    603    \param trackElem The TrackElement to add the Point to
     601 * adds a point to trackElem
     602 * @param newPoint The point to add.
     603 * @param trackElem The TrackElement to add the Point to
    604604*/
    605605void TrackManager::addPointV(Vector newPoint, TrackElement* trackElem)
    … …  
    618618
    619619/**
    620    \brief adds a new Hot Point
    621    \param x: the x coordinate of the hotpoint
    622    \param y: the y coordinate of the hotpoint
    623    \param z: the z coordinate of the hotpoint
     620 * adds a new Hot Point
     621 * @param x: the x coordinate of the hotpoint
     622 * @param y: the y coordinate of the hotpoint
     623 * @param z: the z coordinate of the hotpoint
    624624   \see int TrackManager::addHotPointV(Vector newPoint, TrackElement* trackElem)
    625625*/
    … …  
    630630
    631631/**
    632    \brief adds save/splitpoint.
    633    \param newPoint The point to add.
    634    \param trackElem if supplied it will add a hotpoint on this TrackElement
    635    \returns A Pointer to a newly appended Curve
     632 * adds save/splitpoint.
     633 * @param newPoint The point to add.
     634 * @param trackElem if supplied it will add a hotpoint on this TrackElement
     635 * @returns A Pointer to a newly appended Curve
    636636*/
    637637int TrackManager::addHotPointV(Vector newPoint, TrackElement* trackElem)
    … …  
    646646    }
    647647
    648   // \todo HotPoint Handling.
     648  // @todo HotPoint Handling.
    649649  trackElem->curve->addNode(newPoint);
    650650  trackElem->nodeCount++;
    … …  
    653653
    654654/**
    655    \todo this must be better
     655   @todo this must be better
    656656*/
    657657void TrackManager::setSavePointS(const char* nextElementName)
    … …  
    663663
    664664/**
    665    \brief Sets the last HotPoint into a savePoint.
    666    \param trackElem The TrackElement to appy this to. (if NULL chose this->currentTrackElement)
    667    \returns A Pointer to a newly appended Curve
     665 * Sets the last HotPoint into a savePoint.
     666 * @param trackElem The TrackElement to appy this to. (if NULL chose this->currentTrackElement)
     667 * @returns A Pointer to a newly appended Curve
    668668
    669669   If no HotPoint was defined the last added Point will be rendered into a savePoint. \n
    … …  
    688688
    689689/**
    690    \brief adds some interessting non-linear movments through the level.
    691    \param count The Count of children the fork will produce
     690 * adds some interessting non-linear movments through the level.
     691 * @param count The Count of children the fork will produce
    692692
    693693   If no HotPoint was defined the last added Point will be rendered into a fork. \n
    … …  
    709709
    710710/**
    711    \param count how many children to produce
    712    \param ... the information on the children (these are the Stings of their names
     711 * @param count how many children to produce
     712 * @param ... the information on the children (these are the Stings of their names
    713713   \see TrackManager::fork(unsigned int count, ...)
    714714
    … …  
    747747
    748748/**
    749    \brief adds some interessting non-linear movments through the level.
    750    \param count The Count of childrens the current HotPoint will have.
    751    \param trackIDs A Pointer to an Array of ints which will hold the trackID's (the user will have to reserve space for this).
    752    \param trackNames the names for the tracks as a char-arrey-array
    753    \param trackElem The TrackElement to appy this to. (if NULL choose this->currentTrackElement)
     749 * adds some interessting non-linear movments through the level.
     750 * @param count The Count of childrens the current HotPoint will have.
     751 * @param trackIDs A Pointer to an Array of ints which will hold the trackID's (the user will have to reserve space for this).
     752 * @param trackNames the names for the tracks as a char-arrey-array
     753 * @param trackElem The TrackElement to appy this to. (if NULL choose this->currentTrackElement)
    754754   \see TrackManager::fork(unsigned int count, ...)
    755755*/
    … …  
    770770
    771771/**
    772    \brief decides under what condition a certain Path will be chosen.
    773    \param trackID the trackID to apply this to.
    774    \param cond the CONDITION of the decision
    775    \param subject the Subject that will be decided upon with CONDITION cond.
     772 * decides under what condition a certain Path will be chosen.
     773 * @param trackID the trackID to apply this to.
     774 * @param cond the CONDITION of the decision
     775 * @param subject the Subject that will be decided upon with CONDITION cond.
    776776*/
    777777void TrackManager::condition(unsigned int trackID, CONDITION cond, void* subject)
    … …  
    781781
    782782/**
    783    \brief decides under what condition a certain Path will be chosen.
    784    \param cond the CONDITION of the decision
    785    \param subject the Subject that will be decided upon with CONDITION cond.
    786    \param trackElem The TrackElement to appy this to. (if NULL chose this->currentTrackElement)
     783 * decides under what condition a certain Path will be chosen.
     784 * @param cond the CONDITION of the decision
     785 * @param subject the Subject that will be decided upon with CONDITION cond.
     786 * @param trackElem The TrackElement to appy this to. (if NULL chose this->currentTrackElement)
    787787*/
    788788void TrackManager::condition(CONDITION cond, void* subject, TrackElement* trackElem)
    … …  
    823823
    824824/**
    825    \brief joins some tracks together again.
    826    \param count The count of Paths to join.
     825 * joins some tracks together again.
     826 * @param count The count of Paths to join.
    827827
    828828   Join will set the localTime to the longest time a Path has to get to this Point. \n
    … …  
    844844
    845845/**
    846    \brief Joins some Tracks together again.
    847    \param count The count of trackElements to join
     846 * Joins some Tracks together again.
     847 * @param count The count of trackElements to join
    848848   \see void TrackManager::join(unsigned int count, ...)
    849849
    … …  
    894894
    895895/**
    896    \brief joins some tracks together again.
    897    \param count The count of Paths to join.
    898    \param trackIDs an Array with the trackID's to join
     896 * joins some tracks together again.
     897 * @param count The count of Paths to join.
     898 * @param trackIDs an Array with the trackID's to join
    899899
    900900   \see void TrackManager::join(unsigned int count, ...)
    … …  
    988988
    989989/**
    990    \brief finalizes the TrackSystem. after this it will not be editable anymore
    991 
    992    \todo check for any inconsistencies, output errors
     990 * finalizes the TrackSystem. after this it will not be editable anymore
     991
     992   @todo check for any inconsistencies, output errors
    993993*/
    994994void TrackManager::finalize()
    … …  
    10361036
    10371037/**
    1038    \brief calculates the Position for the localTime of the Track.
    1039    \returns the calculated Position
     1038 * calculates the Position for the localTime of the Track.
     1039 * @returns the calculated Position
    10401040*/
    10411041Vector TrackManager::calcPos() const
    … …  
    10451045
    10461046/**
    1047    \brief calculates the Rotation for the localTime of the Track.
    1048    \returns the calculated Rotation
     1047 * calculates the Rotation for the localTime of the Track.
     1048 * @returns the calculated Rotation
    10491049*/
    10501050Vector TrackManager::calcDir() const
    … …  
    10541054
    10551055/**
    1056    \returns the current Width of the track
     1056 * @returns the current Width of the track
    10571057*/
    10581058float TrackManager::getWidth() const
    … …  
    10621062
    10631063/**
    1064    \brief Advances the local-time of the Track around dt
    1065    \param dt The time about which to advance.
     1064 * Advances the local-time of the Track around dt
     1065 * @param dt The time about which to advance.
    10661066
    10671067   This function also checks, if the TrackElement has to be changed.
    … …  
    11041104
    11051105/**
    1106    \brief Jumps to a certain point on the Track.
    1107    \param time The time on the Track to jump to.
     1106 * Jumps to a certain point on the Track.
     1107 * @param time The time on the Track to jump to.
    11081108
    11091109   This should be used to Jump backwards on a Track, because moving forward means to change between the Path. (it then tries to choose the default.)
    … …  
    11251125
    11261126/**
    1127    \brief a Function that decides which Path we should follow.
    1128    \param trackElem The Path to choose.
     1127 * a Function that decides which Path we should follow.
     1128 * @param trackElem The Path to choose.
    11291129
    11301130*/
    … …  
    11351135
    11361136/**
    1137    \brief Sets the PNode, that should be moved along the Tack
    1138    \param bindSlave the PNode to set
     1137 * Sets the PNode, that should be moved along the Tack
     1138 * @param bindSlave the PNode to set
    11391139*/
    11401140void TrackManager::setBindSlave(PNode* bindSlave)
    … …  
    11441144
    11451145/**
    1146    \returns the main TrackNode
     1146 * @returns the main TrackNode
    11471147*/
    11481148PNode* TrackManager::getTrackNode()
    … …  
    11541154
    11551155/**
    1156    \brief Imports a model of the Graph into the OpenGL-environment.
    1157    \param dt The Iterator used in seconds for Painting the Graph.
     1156 * Imports a model of the Graph into the OpenGL-environment.
     1157 * @param dt The Iterator used in seconds for Painting the Graph.
    11581158
    11591159   This is for testing facility only. Do this if you want to see the Path inside the Level.
    … …  
    11781178
    11791179/**
    1180    \brief outputs debug information about the trackManager
    1181    \param level how much debug
     1180 * outputs debug information about the trackManager
     1181 * @param level how much debug
    11821182*/
    11831183void TrackManager::debug(unsigned int level) const

  • orxonox/trunk/src/util/track/track_manager.h

    r4834 r4836  
    11/*!
    22    \file track_manager.h
    3     \brief manages all tracks defined in the world and the path the player takes
     3  * manages all tracks defined in the world and the path the player takes
    44
    55    it is a container for all tracks and all track-nodes. it manages the movement of
    … …  
    136136 public:
    137137  virtual ~TrackManager();
    138   /** \returns a Pointer to the only object of this Class */
     138  /** @returns a Pointer to the only object of this Class */
    139139  inline static TrackManager* getInstance() { if (!singletonRef) singletonRef = new TrackManager();  return singletonRef; };
    140140
    … …  
    145145  void workOnS(const char* trackName);
    146146
    147   /** \see setCurveType(CurveType curveType, TrackElement* trackElem); \param curveType the type of the Curve */
     147  /** \see setCurveType(CurveType curveType, TrackElement* trackElem); @param curveType the type of the Curve */
    148148  inline void setCurveType(CurveType curveType) { this->setCurveType (curveType, this->currentTrackElem);};
    149149  void setCurveType(CurveType curveType, TrackElement* trackElem);

  • orxonox/trunk/src/util/track/track_node.cc

    r4597 r4836  
    2626
    2727/**
    28    \brief standard constructor
     28 * standard constructor
    2929*/
    3030TrackNode::TrackNode ()
    … …  
    3939
    4040/**
    41    \brief standard deconstructor
     41 * standard deconstructor
    4242*/
    4343TrackNode::~TrackNode ()

  • orxonox/trunk/src/util/track/track_node.h

    r4489 r4836  
    11/*!
    22    \file track_node.h
    3     \brief Definition of the TrackNode are located here
     3  * Definition of the TrackNode are located here
    44   
    55    the TrackNode is the node, that follows the Track (and the TrackManager)

  • orxonox/trunk/src/world_entities/camera.cc

    r4832 r4836  
    3131
    3232/**
    33    \brief creates a Camera
     33 * creates a Camera
    3434*/
    3535Camera::Camera()
    … …  
    5353
    5454/**
    55    \brief default destructor
     55 * default destructor
    5656*/
    5757Camera::~Camera()
    … …  
    6161
    6262/**
    63    \brief focuses the Camera onto a Target
    64    \param target the new PNode the Camera should look at.
     63 * focuses the Camera onto a Target
     64 * @param target the new PNode the Camera should look at.
    6565*/
    6666void Camera::lookAt(PNode* target)
    … …  
    7070
    7171/**
    72    \returns The PNode of the Target (from there you can get position and so on
     72 * @returns The PNode of the Target (from there you can get position and so on
    7373*/
    7474PNode* Camera::getTarget()
    … …  
    7878
    7979/**
    80    \brief sets a new AspectRatio
    81    \param aspectRatio the new aspect ratio to set (width / height)
     80 * sets a new AspectRatio
     81 * @param aspectRatio the new aspect ratio to set (width / height)
    8282*/
    8383void Camera::setAspectRatio(float aspectRatio)
    … …  
    8787
    8888/**
    89    \brief sets the Field of View to fofy
    90    \param fovy new field of view factor (in degrees)
     89 * sets the Field of View to fofy
     90 * @param fovy new field of view factor (in degrees)
    9191*/
    9292void Camera::setFovy(float fovy)
    … …  
    9797/**
    9898  \brief Sets a new clipping region
    99   \param nearClip The near clip plane
    100   \param farClip The far clip plane
     99* @param nearClip The near clip plane
     100* @param farClip The far clip plane
    101101*/
    102102void Camera::setClipRegion(float nearClip, float farClip)
    … …  
    107107
    108108/**
    109    \brief sets the new VideoMode and initializes iteration to it.
    110    \param mode the mode to change to.
     109 * sets the new VideoMode and initializes iteration to it.
     110 * @param mode the mode to change to.
    111111*/
    112112void Camera::setViewMode(ViewMode mode)
    … …  
    143143
    144144/**
    145    \brief Updates the position of the camera.
    146    \param dt: The time that elapsed.
     145 * Updates the position of the camera.
     146 * @param dt: The time that elapsed.
    147147*/
    148148void Camera::tick(float dt)
    … …  
    161161
    162162/**
    163    \brief initialize rendering perspective according to this camera
     163 * initialize rendering perspective according to this camera
    164164
    165165   This is called immediately before the rendering cycle starts, it sets all global
    … …  
    194194
    195195/**
    196    \brief processes an event
    197    \param event: the event to process
     196 * processes an event
     197 * @param event: the event to process
    198198*/
    199199void Camera::process(const Event &event)

  • orxonox/trunk/src/world_entities/camera.h

    r4746 r4836  
    11/*!
    22    \file camera.h
    3     \brief Viewpoint controlling class definitions
     3  * Viewpoint controlling class definitions
    44*/
    55

  • orxonox/trunk/src/world_entities/character_attributes.cc

    r4320 r4836  
    2424
    2525/**
    26    \brief standard constructor
    27    \todo this constructor is not jet implemented - do it
     26 * standard constructor
     27   @todo this constructor is not jet implemented - do it
    2828*/
    2929CharacterAttributes::CharacterAttributes ()
    … …  
    3434
    3535/**
    36    \brief standard deconstructor
     36 * standard deconstructor
    3737
    3838*/
    … …  
    4545
    4646/**
    47    \brief sets the health of the character
    48    \param helath
     47 * sets the health of the character
     48 * @param helath
    4949 */
    5050void CharacterAttributes::setHealth(int health)
    … …  
    5454
    5555/**
    56    \brief adds health to the charater
    57    \param health
    58    \returns health that couldnt be added due to healt limit, 0 if everything worked as normal
     56 * adds health to the charater
     57 * @param health
     58 * @returns health that couldnt be added due to healt limit, 0 if everything worked as normal
    5959 */
    6060int CharacterAttributes::addHealth(int health)
    … …  
    7171
    7272/**
    73    \brief remove health due to damager for example
    74    \param amount of health
    75    \returns false if health is zero -> dead
     73 * remove health due to damager for example
     74 * @param amount of health
     75 * @returns false if health is zero -> dead
    7676 */
    7777bool CharacterAttributes::substractHealth(int health)
    … …  
    8787
    8888/**
    89    \brief gets the current amount of health
    90    \returns health
     89 * gets the current amount of health
     90 * @returns health
    9191 */
    9292int CharacterAttributes::getHealth()
    … …  
    9797
    9898/**
    99    \brief sets maximum health
    100    \param health
     99 * sets maximum health
     100 * @param health
    101101
    102102   if healthMax = 0 -> unlimited
    … …  
    108108
    109109/**
    110    \brief gets health maximium
    111    \returns the health maximum
     110 * gets health maximium
     111 * @returns the health maximum
    112112 */
    113113int CharacterAttributes::getHealthMax()
    … …  
    119119/*======================armor/ shields===================== */
    120120/**
    121    \brief sets the shild strength
    122    \param strength
     121 * sets the shild strength
     122 * @param strength
    123123 */
    124124void CharacterAttributes::setShieldStrength(int shieldStrength)
    … …  
    128128
    129129/**
    130    \brief adds shield strength
    131    \param strength
     130 * adds shield strength
     131 * @param strength
    132132   
    133133   there is currently no limit to shieldstrength
    … …  
    139139
    140140/**
    141    \brief substracts shield strength
    142    \param strength
    143    \returns amount of shield strength below zero after substraction. Magic: Troumble. if everything works allright, it returns 0
     141 * substracts shield strength
     142 * @param strength
     143 * @returns amount of shield strength below zero after substraction. Magic: Troumble. if everything works allright, it returns 0
    144144 */
    145145int CharacterAttributes::substractShieldStrength(int shieldStrength)
    … …  
    155155
    156156/**
    157    \brief gets shield strength
    158    \returns the shield strength
     157 * gets shield strength
     158 * @returns the shield strength
    159159 */
    160160int CharacterAttributes::getShieldStrength()
    … …  
    166166/*=====================damage=====================*/
    167167/**
    168    \brief sets the amount of base damage dealt to all aircrafts
    169    \param damage
     168 * sets the amount of base damage dealt to all aircrafts
     169 * @param damage
    170170
    171171   There can be a difference between arms that hit a ground/air craft. Eg.
    … …  
    179179
    180180/**
    181    \brief gets the amount of base damage
    182    \returns base damage to aircrafts
     181 * gets the amount of base damage
     182 * @returns base damage to aircrafts
    183183
    184184   There can be a difference between arms that hit a ground/air craft. Eg.
    … …  
    193193
    194194/**
    195    \brief sets the amount of base damage dealt to all groundcrafts
    196    \param damage
     195 * sets the amount of base damage dealt to all groundcrafts
     196 * @param damage
    197197
    198198   There can be a difference between arms that hit a ground/air craft. Eg.
    … …  
    206206
    207207/**
    208    \briefgets the amount of base damage
    209    \returns base damage to groundcrafts
     208 * gets the amount of base damage
     209 * @returns base damage to groundcrafts
    210210
    211211   There can be a difference between arms that hit a ground/air craft. Eg.
    … …  
    220220
    221221/**
    222    \brief sets the damage modifier to the damage that is dealed via laser weapons
    223    \param modifier [0..1]
     222 * sets the damage modifier to the damage that is dealed via laser weapons
     223 * @param modifier [0..1]
    224224
    225225   eg. the damage is calculated after: damage = modifier * damageToGroundCraft
    … …  
    231231
    232232/**
    233    \brief gets the damage modifier to the damage that is dealed via laser weapons
    234    \returns damage modifier
     233 * gets the damage modifier to the damage that is dealed via laser weapons
     234 * @returns damage modifier
    235235
    236236   eg. the damage is calculated after: damage = modifier * damageToGroundCraft
    … …  
    243243
    244244/**
    245    \brief sets the damage modifier to the damage that is dealed via plasma weapons
    246    \param damage modifier
     245 * sets the damage modifier to the damage that is dealed via plasma weapons
     246 * @param damage modifier
    247247
    248248   eg. the damage is calculated after: damage = modifier * damageToGroundCraft
    … …  
    254254
    255255/**
    256    \brief gets the damage modifier to the damage that is dealed plasma weapons
    257    \returns damage modifier
     256 * gets the damage modifier to the damage that is dealed plasma weapons
     257 * @returns damage modifier
    258258
    259259   eg. the damage is calculated after: damage = modifier * damageToGroundCraft
    … …  
    266266
    267267/**
    268    \brief sets the damage modifier to the damage that is dealed via explosives
    269    \param damage modifier
     268 * sets the damage modifier to the damage that is dealed via explosives
     269 * @param damage modifier
    270270
    271271   eg. the damage is calculated after: damage = modifier * damageToGroundCraft
    … …  
    277277
    278278/**
    279    \brief sets the damage modifier to the damage that is dealed via explosives
    280    \returns damage modifier
     279 * sets the damage modifier to the damage that is dealed via explosives
     280 * @returns damage modifier
    281281
    282282   eg. the damage is calculated after: damage = modifier * damageToGroundCraft
    … …  
    290290/*=====================energy=====================*/
    291291/**
    292    \brief sets the amount of energy
    293    \param energy
     292 * sets the amount of energy
     293 * @param energy
    294294 */
    295295void CharacterAttributes::setEnergy(int energy)
    … …  
    299299
    300300/**
    301    \brief adds energy to the system
    302    \param amount of energy
    303    \returns amount of energy that is too much due to energy limit
     301 * adds energy to the system
     302 * @param amount of energy
     303 * @returns amount of energy that is too much due to energy limit
    304304 */
    305305int CharacterAttributes::addEnergy(int addEnergy)
    … …  
    316316
    317317/**
    318    \brief substracts energy from a system
    319    \param amount of energy
    320    \returns false if there is no energy anymore
     318 * substracts energy from a system
     319 * @param amount of energy
     320 * @returns false if there is no energy anymore
    321321 */
    322322bool CharacterAttributes::substractEnergy(int subEnergy)
    … …  
    332332
    333333/**
    334    \brief gets the amount of energy
    335    \returns energy
     334 * gets the amount of energy
     335 * @returns energy
    336336 */
    337337int CharacterAttributes::getEnergy()
    … …  
    342342
    343343/**
    344    \brief sets the energy consumption
    345    \param amount of energy
     344 * sets the energy consumption
     345 * @param amount of energy
    346346*/
    347347void CharacterAttributes::setEnergyConsumption(int energy)
    … …  
    351351
    352352/**
    353    \brief gets the energy consumption
    354    \returns amount of energy
     353 * gets the energy consumption
     354 * @returns amount of energy
    355355*/
    356356int CharacterAttributes::getEnergyConsumption()
    … …  
    361361
    362362/**
    363    \brief sets the maximum energy level
    364    \param amount of energy
     363 * sets the maximum energy level
     364 * @param amount of energy
    365365*/
    366366void CharacterAttributes::setEnergyMax(int energy)
    … …  
    370370
    371371/**
    372    \brief gets the max energy level
    373    \returns amount of energy
     372 * gets the max energy level
     373 * @returns amount of energy
    374374*/
    375375int CharacterAttributes::getEnergyMax()

  • orxonox/trunk/src/world_entities/character_attributes.h

    r3583 r4836  
    11/*!
    22    \file character_attributes.h
    3     \brief Definition of the attributes of a character (healt, armor,.. ) whatever is important to the character
     3  * Definition of the attributes of a character (healt, armor,.. ) whatever is important to the character
    44*/
    55

  • orxonox/trunk/src/world_entities/environment.cc

    r4724 r4836  
    2828
    2929/**
    30    \brief creates an environment
     30 * creates an environment
    3131*/
    3232Environment::Environment () : WorldEntity()
    … …  
    4040
    4141/**
    42    \brief deletes an environment
     42 * deletes an environment
    4343*/
    4444Environment::~Environment ()
    … …  
    4848
    4949/**
    50    \brief ticks the environment
    51    \param time the time about which to tick
     50 * ticks the environment
     51 * @param time the time about which to tick
    5252*/
    5353void Environment::tick (float time) {}
    5454
    5555/**
    56    \brief if a hit occures
     56 * if a hit occures
    5757*/
    5858void Environment::hit (WorldEntity* weapon, Vector* loc) {}
    5959
    6060/**
    61    \brief destroys an Environment
     61 * destroys an Environment
    6262*/
    6363void Environment::destroy () {}
    6464
    6565/**
    66    \brief a collision with some ship
     66 * a collision with some ship
    6767*/
    6868void Environment::collide (WorldEntity* other,  Uint32 ownhitflags, Uint32 otherhitflags) {}
    6969
    7070/**
    71    \brief draws the Environment
     71 * draws the Environment
    7272*/
    7373void Environment::draw ()

  • orxonox/trunk/src/world_entities/player.cc

    r4834 r4836  
    4141
    4242/**
    43    \brief creates a new Player
    44    \param isFree if the player is free
     43 * creates a new Player
     44 * @param isFree if the player is free
    4545*/
    4646Player::Player()
    … …  
    6565
    6666/**
    67    \brief destructs the player, deletes alocated memory
     67 * destructs the player, deletes alocated memory
    6868*/
    6969Player::~Player ()
    … …  
    7878
    7979/**
    80    \brief creates a new Player from Xml Data
    81    \param root the xml element containing player data
    82 
    83    \todo add more parameters to load
     80 * creates a new Player from Xml Data
     81 * @param root the xml element containing player data
     82
     83   @todo add more parameters to load
    8484*/
    8585Player::Player(const TiXmlElement* root)
    … …  
    132132
    133133/**
    134    \brief adds a weapon to the weapon list of player
    135    \param weapon to add
     134 * adds a weapon to the weapon list of player
     135 * @param weapon to add
    136136*/
    137137void Player::addWeapon(Weapon* weapon)
    … …  
    142142
    143143/**
    144    \brief removes a weapon from the player
    145    \param weapon to remove
     144 * removes a weapon from the player
     145 * @param weapon to remove
    146146*/
    147147void Player::removeWeapon(Weapon* weapon)
    … …  
    152152
    153153/**
    154    \brief effect that occurs after the player is spawned
     154 * effect that occurs after the player is spawned
    155155*/
    156156void Player::postSpawn ()
    … …  
    161161
    162162/**
    163    \brief the action occuring if the player left the game
     163 * the action occuring if the player left the game
    164164*/
    165165void Player::leftWorld ()
    … …  
    169169
    170170/**
    171    \brief if the player is hit, call this function
    172    \param weapon hit by this weapon
    173    \param loc ??
     171 * if the player is hit, call this function
     172 * @param weapon hit by this weapon
     173 * @param loc ??
    174174*/
    175175void Player::hit (WorldEntity* weapon, Vector* loc)
    … …  
    179179
    180180/**
    181     \brief Collision with another Entity has this effect
    182     \param other the other colider
    183     \param ownhitflags ??
    184     \param otherhitflags ??
     181  * Collision with another Entity has this effect
     182  * @param other the other colider
     183  * @param ownhitflags ??
     184  * @param otherhitflags ??
    185185*/
    186186void Player::collide (WorldEntity* other, Uint32 ownhitflags, Uint32 otherhitflags)
    … …  
    190190
    191191/**
    192    \brief draws the player after transforming him.
     192 * draws the player after transforming him.
    193193*/
    194194void Player::draw ()
    … …  
    214214
    215215/**
    216    \brief the function called for each passing timeSnap
    217    \param time The timespan passed since last update
     216 * the function called for each passing timeSnap
     217 * @param time The timespan passed since last update
    218218*/
    219219void Player::tick (float time)
    … …  
    234234
    235235/**
    236    \brief action if player moves
    237    \param time the timeslice since the last frame
     236 * action if player moves
     237 * @param time the timeslice since the last frame
    238238*/
    239239void Player::move (float time)
    … …  
    256256    accel = accel + (orthDirection*acceleration);
    257257  if( this->bAscend )
    258   if( this->bDescend) {/* FIXME */} /* \todo up and down player movement */
     258  if( this->bDescend) {/* FIXME */} /* @todo up and down player movement */
    259259
    260260  Vector move = accel * time;
    … …  
    264264
    265265/**
    266    \brief weapon manipulation by the player
     266 * weapon manipulation by the player
    267267*/
    268268void Player::weapon()
    … …  
    281281
    282282/**
    283    \brief The connection to the command node
    284    \param cmd the Command unit from witch to map
     283 * The connection to the command node
     284 * @param cmd the Command unit from witch to map
    285285
    286286   here the commands are mapped to the players movement/weaponary

  • orxonox/trunk/src/world_entities/player.h

    r4834 r4836  
    11/*!
    22    \file player.h
    3     \brief Implements a basic controllable WorldEntity
     3  * Implements a basic controllable WorldEntity
    44 */
    55

  • orxonox/trunk/src/world_entities/power_up.h

    r3544 r4836  
    11/*!
    22    \file power_up.h
    3     \brief A class representing a PowerUp in the world.
     3  * A class representing a PowerUp in the world.
    44*/
    55

  • orxonox/trunk/src/world_entities/satellite.cc

    r4597 r4836  
    2727
    2828/**
    29    \brief standard constructor
     29 * standard constructor
    3030*/
    3131Satellite::Satellite (Vector axis, float speed)
    … …  
    4040
    4141/**
    42    \brief standard destructor
     42 * standard destructor
    4343*/
    4444Satellite::~Satellite ()
    … …  
    5151
    5252/**
    53    \brief this method is called every frame
    54    \param time: the time in seconds that has passed since the last tick
     53 * this method is called every frame
     54 * @param time: the time in seconds that has passed since the last tick
    5555
    5656   Handle all stuff that should update with time inside this method (movement, animation, etc.)
    … …  
    6868
    6969/**
    70    \brief the entity is drawn onto the screen with this function
     70 * the entity is drawn onto the screen with this function
    7171
    7272   This is a central function of an entity: call it to let the entity painted to the screen. Just override this function with whatever you want to be drawn.

  • orxonox/trunk/src/world_entities/satellite.h

    r4597 r4836  
    11/*!
    22    \file world_entity.h
    3     \brief Definition of the basic WorldEntity
     3  * Definition of the basic WorldEntity
    44*/
    55

  • orxonox/trunk/src/world_entities/skybox.cc

    r4746 r4836  
    3434
    3535/**
    36    \brief Constructs a SkyBox and takes fileName as a map.
    37    \param fileName the file to take as input for the SkyBox
     36 * Constructs a SkyBox and takes fileName as a map.
     37 * @param fileName the file to take as input for the SkyBox
    3838*/
    3939SkyBox::SkyBox(const char* fileName)
    … …  
    4646
    4747/**
    48    \brief initializes a skybox from a XmlElement
     48 * initializes a skybox from a XmlElement
    4949*/
    5050SkyBox::SkyBox(const TiXmlElement* root)
    … …  
    9393
    9494/**
    95    \brief default destructor
     95 * default destructor
    9696*/
    9797SkyBox::~SkyBox()
    … …  
    104104
    105105/**
    106    \brief sets A set of textures when just giving a Name and an extension:
     106 * sets A set of textures when just giving a Name and an extension:
    107107
    108108   usage: give this function an argument like
    … …  
    140140
    141141/**
    142    \brief Defines which textures should be loaded onto the SkyBox.
    143    \param top the top texture.
    144    \param bottom the bottom texture.
    145    \param left the left texture.
    146    \param right the right texture.
    147    \param front the front texture.
    148    \param back the back texture.
     142 * Defines which textures should be loaded onto the SkyBox.
     143 * @param top the top texture.
     144 * @param bottom the bottom texture.
     145 * @param left the left texture.
     146 * @param right the right texture.
     147 * @param front the front texture.
     148 * @param back the back texture.
    149149*/
    150150void SkyBox::setTextures(const char* top, const char* bottom, const char* left, const char* right, const char* front, const char* back)
    … …  
    159159
    160160/**
    161    \param size The new size of the SkyBox
     161 * @param size The new size of the SkyBox
    162162
    163163 * do not forget to rebuild the SkyBox after this.
    … …  
    169169
    170170/**
    171    \brief draws the SkyBox
     171 * draws the SkyBox
    172172*/
    173173void SkyBox::draw()
    … …  
    185185
    186186/**
    187    \brief rebuilds the SkyBox
     187 * rebuilds the SkyBox
    188188
    189189   this must be done, when changing the Size of the Skybox (runtime-efficency)

  • orxonox/trunk/src/world_entities/skybox.h

    r4746 r4836  
    11/*!
    22    \file skybox.h
    3     \brief Definition of the SkyBox, that handles the Display of an atmosphere for orxonox.
     3  * Definition of the SkyBox, that handles the Display of an atmosphere for orxonox.
    44
    55    A SkyBox is always centered at the current working Camera, and will only obey the cameras

  • orxonox/trunk/src/world_entities/skysphere.cc

    r4597 r4836  
    3838
    3939/**
    40    \brief Constructs a SkySphere and takes fileName as a map.
    41    \param fileName the file to take as input for the skysphere
     40 * Constructs a SkySphere and takes fileName as a map.
     41 * @param fileName the file to take as input for the skysphere
    4242*/
    4343Skysphere::Skysphere(char* fileName)
    … …  
    5353
    5454/**
    55    \brief default destructor
     55 * default destructor
    5656*/
    5757Skysphere::~Skysphere()
    … …  
    6363
    6464/**
    65    \brief initializes the Skysphere.
    66    \param fileName the file to take as input for the skysphere
     65 * initializes the Skysphere.
     66 * @param fileName the file to take as input for the skysphere
    6767*/
    6868void Skysphere::initialize(char* fileName)
    … …  
    8383
    8484/**
    85    \brief Defines which texture should be loaded onto the skysphere.
    86    \param fileName The filename of the Texture
     85 * Defines which texture should be loaded onto the skysphere.
     86 * @param fileName The filename of the Texture
    8787*/
    8888void Skysphere::setTexture(char* fileName)
    … …  
    9393
    9494/**
    95    \brief draws the Skysphere
     95 * draws the Skysphere
    9696
    9797   This part is normally precessed in the "Painting Phase".
    … …  
    115115
    116116/**
    117    \brief sets the Radius of the Sphere.
    118    \param radius The Radius of The Sphere
     117 * sets the Radius of the Sphere.
     118 * @param radius The Radius of The Sphere
    119119*/
    120120void Skysphere::setRadius(float radius)

  • orxonox/trunk/src/world_entities/skysphere.h

    r4597 r4836  
    11/*!
    22    \file skysphere.h
    3     \brief Definition of the Skysphere, that handles the Display of an atmosphere of orxonox.
     3  * Definition of the Skysphere, that handles the Display of an atmosphere of orxonox.
    44
    55    A SkySphere is always centered at the current working Camera, and will only obey the cameras
    66    movment but not its rotation.
    77
    8     \todo self-rotation
    9     \todo handle reference to parent-object
     8    @todo self-rotation
     9    @todo handle reference to parent-object
    1010*/
    1111

  • orxonox/trunk/src/world_entities/terrain.cc

    r4746 r4836  
    2929
    3030/**
    31    \brief standard constructor
     31 * standard constructor
    3232
    3333*/
    … …  
    3939
    4040/**
    41    \brief Constructor for loading a Terrain out of a file
    42    \param fileName The file to load data from.
     41 * Constructor for loading a Terrain out of a file
     42 * @param fileName The file to load data from.
    4343
    4444   this either loads out of an OBJ-file, or loads a heightmap if no .obj-extension is found.
    … …  
    5959
    6060/**
    61    \brief a Constructor for the Debug-Worlds
    62 
    63    \todo make it not compileable when not in debug-mode
     61 * a Constructor for the Debug-Worlds
     62
     63   @todo make it not compileable when not in debug-mode
    6464*/
    6565Terrain::Terrain(DebugTerrain debugTerrain)
    … …  
    7070
    7171/**
    72    \brief standard deconstructor
     72 * standard deconstructor
    7373
    7474*/

  • orxonox/trunk/src/world_entities/terrain.h

    r4746 r4836  
    11/*!
    22    \file terrain.h
    3     \brief Defines and handles the terrain of the World
     3  * Defines and handles the terrain of the World
    44
    5     \todo implement it
     5    @todo implement it
    66
    77    The terrain should either be build from a Model a OBJModel or from a HeightMap.

  • orxonox/trunk/src/world_entities/weapons/crosshair.h

    r4832 r4836  
    11/*!
    22    \file crosshair.h
    3     \brief Definition of ...
     3  * Definition of ...
    44
    55*/

  • orxonox/trunk/src/world_entities/weapons/projectile.cc

    r4758 r4836  
    2929
    3030/**
    31    \brief standard constructor
     31 * standard constructor
    3232*/
    3333Projectile::Projectile (Weapon* weapon) : WorldEntity()
    … …  
    4444
    4545/**
    46    \brief standard deconstructor
     46 * standard deconstructor
    4747*/
    4848Projectile::~Projectile ()
    … …  
    5757
    5858/**
    59    \brief this sets the flight direction of the projectile
    60    \param directin in which to flight
     59 * this sets the flight direction of the projectile
     60 * @param directin in which to flight
    6161
    6262   this function will calculate a vector out of this to be used in the
    … …  
    7474
    7575/**
    76    \brief this sets the time to life of the projectile
    77    \param ttl in second
     76 * this sets the time to life of the projectile
     77 * @param ttl in second
    7878
    7979   after this life time, the projectile will garbage collect itself
    … …  
    8686
    8787/**
    88    \brief sets the speed of the projectile
     88 * sets the speed of the projectile
    8989*/
    9090void Projectile::setSpeed(float speed)
    … …  
    9696
    9797/**
    98    \brief sets the velocity vector to a spec speed
    99    \param velocity: vector of the velocity
     98 * sets the velocity vector to a spec speed
     99 * @param velocity: vector of the velocity
    100100*/
    101101void Projectile::setVelocity(const Vector &velocity)
    … …  
    108108
    109109/**
    110    \brief signal tick, time dependent things will be handled here
    111    \param time since last tick
     110 * signal tick, time dependent things will be handled here
     111 * @param time since last tick
    112112*/
    113113void Projectile::tick (float time)
    … …  
    128128
    129129/**
    130    \brief the projectile gets hit by another entity
    131    \param the other entity
    132    \param place where it is hit
     130 * the projectile gets hit by another entity
     131 * @param the other entity
     132 * @param place where it is hit
    133133*/
    134134void Projectile::hit (WorldEntity* entity, Vector* place)
    … …  
    137137
    138138/**
    139    \brief the function gets called, when the projectile is destroyed
     139 * the function gets called, when the projectile is destroyed
    140140*/
    141141void Projectile::destroy ()

  • orxonox/trunk/src/world_entities/weapons/projectile.h

    r4758 r4836  
    11/*!
    22    \projectile.h
    3     \brief a projectile, that is been shooted by a weapon
     3  * a projectile, that is been shooted by a weapon
    44
    55    You can use this class to make some shoots, but this isn't the real idea. If you want to just test, if the

  • orxonox/trunk/src/world_entities/weapons/test_bullet.cc

    r4758 r4836  
    2929
    3030/**
    31    \brief standard constructor
     31 * standard constructor
    3232*/
    3333TestBullet::TestBullet (Weapon* weapon) : Projectile(weapon)
    … …  
    4141
    4242/**
    43    \brief standard deconstructor
     43 * standard deconstructor
    4444*/
    4545TestBullet::~TestBullet ()
    … …  
    5555
    5656/**
    57    \brief signal tick, time dependent things will be handled here
    58    \param time since last tick
     57 * signal tick, time dependent things will be handled here
     58 * @param time since last tick
    5959*/
    6060void TestBullet::tick (float time)
    … …  
    7676
    7777/**
    78    \brief the projectile gets hit by another entity
    79    \param the other entity
    80    \param place where it is hit
     78 * the projectile gets hit by another entity
     79 * @param the other entity
     80 * @param place where it is hit
    8181*/
    8282void TestBullet::hit (WorldEntity* entity, Vector* place)
    … …  
    8585
    8686/**
    87    \brief the function gets called, when the projectile is destroyed
     87 * the function gets called, when the projectile is destroyed
    8888*/
    8989void TestBullet::destroy ()

  • orxonox/trunk/src/world_entities/weapons/test_bullet.h

    r4758 r4836  
    11/*!
    22    \projectile.h
    3     \brief a projectile, that is been shooted by a weapon
     3  * a projectile, that is been shooted by a weapon
    44*/
    55

  • orxonox/trunk/src/world_entities/weapons/test_gun.cc

    r4829 r4836  
    1616
    1717
    18    \todo: direction in which the projectile flights
    19    \todo: a target to set/hit
     18   @todo: direction in which the projectile flights
     19   @todo: a target to set/hit
    2020*/
    2121
    … …  
    3939
    4040/**
    41    \brief standard constructor
     41 * standard constructor
    4242
    4343   creates a new weapon
    … …  
    103103
    104104/**
    105    \brief standard deconstructor
     105 * standard deconstructor
    106106*/
    107107TestGun::~TestGun ()
    … …  
    112112
    113113/**
    114    \brief this activates the weapon
     114 * this activates the weapon
    115115
    116116   This is needed, since there can be more than one weapon on a ship. the
    … …  
    125125
    126126/**
    127    \brief this deactivates the weapon
     127 * this deactivates the weapon
    128128
    129129   This is needed, since there can be more than one weapon on a ship. the
    … …  
    138138
    139139/**
    140    \brief fires the weapon
     140 * fires the weapon
    141141
    142142   this is called from the player.cc, when fire-button is been pushed
    143    \todo: the ObjectManager deliveres Projectiles not TestBullets! this should be diffrent
     143   @todo: the ObjectManager deliveres Projectiles not TestBullets! this should be diffrent
    144144*/
    145145void TestGun::fire()
    … …  
    165165
    166166/**
    167    \brief is called, when the weapon gets hit (=collide with something)
    168    \param from which entity it is been hit
    169    \param where it is been hit
     167 * is called, when the weapon gets hit (=collide with something)
     168 * @param from which entity it is been hit
     169 * @param where it is been hit
    170170
    171171   this may not be used, since it would make the game relay complicated when one
    … …  
    177177
    178178/**
    179    \brief is called, when the weapon is destroyed
     179 * is called, when the weapon is destroyed
    180180
    181181   this is in conjunction with the hit function, so when a weapon is able to get
    … …  
    187187
    188188/**
    189    \brief tick signal for time dependent/driven stuff
     189 * tick signal for time dependent/driven stuff
    190190*/
    191191void TestGun::tick (float time)
    … …  
    196196
    197197/**
    198    \brief is called, when there is no fire button pressed
     198 * is called, when there is no fire button pressed
    199199*/
    200200void TestGun::weaponIdle()
    … …  
    203203
    204204/**
    205    \brief this will draw the weapon
     205 * this will draw the weapon
    206206*/
    207207void TestGun::draw ()

  • orxonox/trunk/src/world_entities/weapons/test_gun.h

    r4827 r4836  
    11/*!
    22    \file weapon.h
    3     \brief a weapon that a player can use
     3  * a weapon that a player can use
    44
    55    A Player has a list of weapons, that can be choosen to shoot projectiles

  • orxonox/trunk/src/world_entities/weapons/weapon.cc

    r4834 r4836  
    2525
    2626/**
    27    \brief standard constructor
     27 * standard constructor
    2828
    2929   creates a new weapon
    … …  
    3838
    3939/**
    40    \brief standard deconstructor
     40 * standard deconstructor
    4141*/
    4242Weapon::~Weapon ()
    … …  
    5252
    5353/**
    54     \brief enables the weapon
     54  * enables the weapon
    5555
    5656    a weapon can be enabled/disabled because of various reasons. if a weapon is
    … …  
    6565
    6666/**
    67     \brief disables the weapon
     67  * disables the weapon
    6868
    6969    a weapon can be enabled/disabled because of various reasons. if a weapon is
    … …  
    7878
    7979/**
    80     \brief checks if the weapon is enabled
    81     \returns true if enabled
     80  * checks if the weapon is enabled
     81  * @returns true if enabled
    8282
    8383    a weapon can be ebabled/disabled because of various reasons. if a weapon is
    … …  
    9292
    9393/**
    94    \brief sets a new projectile to the weapon
    95    \param new projectile for this weapon
     94 * sets a new projectile to the weapon
     95 * @param new projectile for this weapon
    9696
    9797   weapon an projectile are independent, so you can combine them as you want
    … …  
    104104
    105105/**
    106    \brief sets a new projectile to the weapon
    107    \returns the current projectile of this weapon
     106 * sets a new projectile to the weapon
     107 * @returns the current projectile of this weapon
    108108
    109109   weapon an projectile are independent, so you can combine them as you want
    … …  
    116116
    117117/**
    118    \brief this activates the weapon
     118 * this activates the weapon
    119119
    120120   This is needed, since there can be more than one weapon on a ship. the
    … …  
    127127
    128128/**
    129    \brief this deactivates the weapon
     129 * this deactivates the weapon
    130130
    131131   This is needed, since there can be more than one weapon on a ship. the
    … …  
    137137
    138138/**
    139    \brief asks if the current weapon is active
    140    \returns true if it the weapon is active
     139 * asks if the current weapon is active
     140 * @returns true if it the weapon is active
    141141*/
    142142bool Weapon::isActive()
    … …  
    149149
    150150/**
    151    \brief is called, when the weapon gets hit (=collide with something)
    152    \param from which entity it is been hit
    153    \param where it is been hit
     151 * is called, when the weapon gets hit (=collide with something)
     152 * @param from which entity it is been hit
     153 * @param where it is been hit
    154154
    155155   this may not be used, since it would make the game relay complicated when one
    … …  
    161161
    162162/**
    163    \brief is called, when the weapon is destroyed
     163 * is called, when the weapon is destroyed
    164164
    165165   this is in conjunction with the hit function, so when a weapon is able to get
    … …  
    171171
    172172/**
    173    \brief tick signal for time dependent/driven stuff
     173 * tick signal for time dependent/driven stuff
    174174*/
    175175void Weapon::tick (float time)
    … …  
    178178
    179179/**
    180    \brief is called, when there is no fire button pressed
     180 * is called, when there is no fire button pressed
    181181*/
    182182void Weapon::weaponIdle()
    … …  
    185185
    186186/**
    187    \brief this will draw the weapon
     187 * this will draw the weapon
    188188*/
    189189void Weapon::draw ()

  • orxonox/trunk/src/world_entities/weapons/weapon.h

    r4832 r4836  
    11/*!
    22    \file weapon.h
    3     \brief a weapon that a  can use
     3  * a weapon that a  can use
    44
    55
    … …  
    9797  inline bool hasWeaponIdleTimeElapsed() const { return (this->localTime>this->idleTime)?true:false; };
    9898
    99   /** @brief fires the weapon */
     99  /** fires the weapon */
    100100  virtual void fire() = 0;
    101101  virtual void hit (WorldEntity* weapon, const Vector& loc);

  • orxonox/trunk/src/world_entities/weapons/weapon_manager.h

    r4834 r4836  
    11/*!
    22    \file weapon.h
    3     \brief a weapon that a player can use
     3  * a weapon that a player can use
    44
    55    A Player has a list of weapons, that can be choosen to shoot projectiles

  • orxonox/trunk/src/world_entities/world_entity.cc

    r4814 r4836  
    2626
    2727/**
    28    \brief Loads the WordEntity-specific Part of any derived Class
     28 * Loads the WordEntity-specific Part of any derived Class
    2929*/
    3030WorldEntity::WorldEntity(const TiXmlElement* root)
    … …  
    4242
    4343/**
    44    \brief standard destructor
     44 * standard destructor
    4545*/
    4646WorldEntity::~WorldEntity ()
    … …  
    6262
    6363/**
    64    \brief loads a Model onto a WorldEntity
    65    \param fileName the name of the model to load
     64 * loads a Model onto a WorldEntity
     65 * @param fileName the name of the model to load
    6666*/
    6767void WorldEntity::loadModel(const char* fileName)
    … …  
    7979
    8080/**
    81    \brief sets the character attributes of a worldentity
    82    \param character attributes
     81 * sets the character attributes of a worldentity
     82 * @param character attributes
    8383
    8484   these attributes don't have to be set, only use them, if you need them
    … …  
    8989
    9090/**
    91    \brief gets the Character attributes of this worldentity
    92    \returns character attributes
     91 * gets the Character attributes of this worldentity
     92 * @returns character attributes
    9393*/
    9494CharacterAttributes* WorldEntity::getCharacterAttributes()
    … …  
    9797
    9898/**
    99    \brief set the WorldEntity's collision hull
    100    \param newhull: a pointer to a completely assembled CollisionCluster
     99 * set the WorldEntity's collision hull
     100 * @param newhull: a pointer to a completely assembled CollisionCluster
    101101
    102102   Any previously assigned collision hull will be deleted on reassignment
    … …  
    113113
    114114/**
    115     \brief process draw function
     115  * process draw function
    116116*/
    117117void WorldEntity::processDraw ()
    … …  
    121121
    122122/**
    123    \brief sets the drawable state of this entity.
    124    \param bDraw TRUE if draweable, FALSE otherwise
     123 * sets the drawable state of this entity.
     124 * @param bDraw TRUE if draweable, FALSE otherwise
    125125*/
    126126void WorldEntity::setDrawable (bool bDraw)
    … …  
    131131
    132132/**
    133    \brief this function is called, when two entities collide
    134    \param entity: the world entity with whom it collides
     133 * this function is called, when two entities collide
     134 * @param entity: the world entity with whom it collides
    135135
    136136   Implement behaviour like damage application or other miscellaneous collision stuff in this function
    … …  
    143143
    144144/**
    145    \brief this function is called, when the ship is hit by a waepon
    146    \param weapon: the laser/rocket/shoot that hits.
    147    \param loc: place where it is hit
     145 * this function is called, when the ship is hit by a waepon
     146 * @param weapon: the laser/rocket/shoot that hits.
     147 * @param loc: place where it is hit
    148148
    149149   calculate the damage depending
    … …  
    153153
    154154/**
    155    \brief this is called immediately after the Entity has been constructed and initialized
     155 * this is called immediately after the Entity has been constructed and initialized
    156156
    157157   Put any initialisation code that requires knowledge of location (placement if the Entity is free) and owner of the entity here.
    … …  
    164164
    165165/**
    166    \brief this method is called by the world if the WorldEntity leaves valid gamespace
     166 * this method is called by the world if the WorldEntity leaves valid gamespace
    167167
    168168   For free entities this means it left the Track boundaries. With bound entities it means its Location adresses a
    … …  
    175175
    176176/**
    177    \brief this method is called every frame
    178    \param time: the time in seconds that has passed since the last tick
     177 * this method is called every frame
     178 * @param time: the time in seconds that has passed since the last tick
    179179
    180180   Handle all stuff that should update with time inside this method (movement, animation, etc.)
    … …  
    186186
    187187/**
    188    \brief the entity is drawn onto the screen with this function
     188 * the entity is drawn onto the screen with this function
    189189
    190190   This is a central function of an entity: call it to let the entity painted to the screen. Just override this function with whatever you want to be drawn.
    … …  
    230230
    231231/**
    232    \brief this handles incoming command messages
    233    \param cmd: a pointer to the incoming Command structure
     232 * this handles incoming command messages
     233 * @param cmd: a pointer to the incoming Command structure
    234234
    235235   Put all code that handles Command messages here, this will mainly be called by the assigned CommandNode but can also be used

  • orxonox/trunk/src/world_entities/world_entity.h

    r4746 r4836  
    11/*!
    22    \file world_entity.h
    3     \brief Definition of the basic WorldEntity
     3  * Definition of the basic WorldEntity
    44*/
    55
    … …  
    5050  virtual void command (Command* cmd);
    5151
    52   /** \returns the Count of Faces on this WorldEntity */
     52  /** @returns the Count of Faces on this WorldEntity */
    5353  virtual unsigned int getFaceCount () const { if (this->model) return this->model->getFaceCount(); else return 0; };
    5454
Note: See TracChangeset for help on using the changeset viewer.