Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

Changeset 4836 in orxonox.OLD for orxonox/trunk/src/util


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/util
Files:
26 edited

Legend:

Unmodified
Added
Removed

  • 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)
Note: See TracChangeset for help on using the changeset viewer.