Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

Changeset 4836 in orxonox.OLD for orxonox/trunk/src/lib/physics/fields


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/lib/physics/fields
Files:
9 edited

Legend:

Unmodified
Added
Removed

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    r4395 r4836  
    11/*!
    22    \file twirl.h
    3     \brief Definition of ...
     3  * Definition of ...
    44
    55*/
Note: See TracChangeset for help on using the changeset viewer.