Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

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 :)

File:
1 edited

Legend:

Unmodified
Added
Removed

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