Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

Ignore:
Timestamp:
Jul 12, 2005, 12:33:16 AM (20 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/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
Note: See TracChangeset for help on using the changeset viewer.