Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

Changeset 4836 in orxonox.OLD for orxonox/trunk/src/lib/graphics/light.cc


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/graphics/light.cc

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