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/lib/graphics/importer/material.cc

    r4834 r4836  
    2525#include <string.h>
    2626
    27 //! \todo check if we are in RESOURCE MANAGER-mode
     27//! @todo check if we are in RESOURCE MANAGER-mode
    2828#include "resource_manager.h"
    2929
     
    3131
    3232/**
    33    \brief creates a Material.
    34    \param mtlName Name of the Material to be added to the Material List
     33 * creates a Material.
     34 * @param mtlName Name of the Material to be added to the Material List
    3535*/
    3636Material::Material (const char* mtlName)
     
    5252
    5353/**
    54     \brief deletes a Material
     54  * deletes a Material
    5555*/
    5656Material::~Material()
     
    6767
    6868/**
    69    \brief sets the material with which the following Faces will be painted
     69 * sets the material with which the following Faces will be painted
    7070*/
    7171bool Material::select ()
     
    9999
    100100  // setting illumination Model
    101   if (this->illumModel == 1) //! \todo make this work, if no vertex-normals are read.
     101  if (this->illumModel == 1) //! @todo make this work, if no vertex-normals are read.
    102102    glShadeModel(GL_FLAT);
    103103  else if (this->illumModel >= 2)
     
    124124
    125125/**
    126    \brief Sets the Material Illumination Model.
    127    \brief illu illumination Model in int form
     126 * Sets the Material Illumination Model.
     127 * illu illumination Model in int form
    128128*/
    129129void Material::setIllum (int illum)
     
    133133}
    134134/**
    135    \brief Sets the Material Illumination Model.
    136    \brief illu illumination Model in char* form
     135 * Sets the Material Illumination Model.
     136 * illu illumination Model in char* form
    137137*/void Material::setIllum (char* illum)
    138138{
     
    141141
    142142/**
    143    \brief Sets the Material Diffuse Color.
    144    \param r Red Color Channel.
    145    \param g Green Color Channel.
    146    \param b Blue Color Channel.
     143 * Sets the Material Diffuse Color.
     144 * @param r Red Color Channel.
     145 * @param g Green Color Channel.
     146 * @param b Blue Color Channel.
    147147*/
    148148void Material::setDiffuse (float r, float g, float b)
     
    156156}
    157157/**
    158    \brief Sets the Material Diffuse Color.
    159    \param rgb The red, green, blue channel in char format (with spaces between them)
     158 * Sets the Material Diffuse Color.
     159 * @param rgb The red, green, blue channel in char format (with spaces between them)
    160160*/
    161161void Material::setDiffuse (char* rgb)
     
    167167
    168168/**
    169    \brief Sets the Material Ambient Color.
    170    \param r Red Color Channel.
    171    \param g Green Color Channel.
    172    \param b Blue Color Channel.
     169 * Sets the Material Ambient Color.
     170 * @param r Red Color Channel.
     171 * @param g Green Color Channel.
     172 * @param b Blue Color Channel.
    173173*/
    174174void Material::setAmbient (float r, float g, float b)
     
    181181}
    182182/**
    183    \brief Sets the Material Ambient Color.
    184    \param rgb The red, green, blue channel in char format (with spaces between them)
     183 * Sets the Material Ambient Color.
     184 * @param rgb The red, green, blue channel in char format (with spaces between them)
    185185*/
    186186void Material::setAmbient (char* rgb)
     
    192192
    193193/**
    194    \brief Sets the Material Specular Color.
    195    \param r Red Color Channel.
    196    \param g Green Color Channel.
    197    \param b Blue Color Channel.
     194 * Sets the Material Specular Color.
     195 * @param r Red Color Channel.
     196 * @param g Green Color Channel.
     197 * @param b Blue Color Channel.
    198198*/
    199199void Material::setSpecular (float r, float g, float b)
     
    206206 }
    207207/**
    208    \brief Sets the Material Specular Color.
    209    \param rgb The red, green, blue channel in char format (with spaces between them)
     208 * Sets the Material Specular Color.
     209 * @param rgb The red, green, blue channel in char format (with spaces between them)
    210210*/
    211211void Material::setSpecular (char* rgb)
     
    217217
    218218/**
    219    \brief Sets the Material Shininess.
    220    \param shini stes the Shininess from float.
     219 * Sets the Material Shininess.
     220 * @param shini stes the Shininess from float.
    221221*/
    222222void Material::setShininess (float shini)
     
    225225}
    226226/**
    227    \brief Sets the Material Shininess.
    228    \param shini stes the Shininess from char*.
     227 * Sets the Material Shininess.
     228 * @param shini stes the Shininess from char*.
    229229*/
    230230void Material::setShininess (char* shini)
     
    234234
    235235/**
    236    \brief Sets the Material Transparency.
    237    \param trans stes the Transparency from int.
     236 * Sets the Material Transparency.
     237 * @param trans stes the Transparency from int.
    238238*/
    239239void Material::setTransparency (float trans)
     
    243243}
    244244/**
    245    \brief Sets the Material Transparency.
    246    \param trans stes the Transparency from char*.
     245 * Sets the Material Transparency.
     246 * @param trans stes the Transparency from char*.
    247247*/
    248248void Material::setTransparency (char* trans)
     
    252252
    253253/**
    254    \brief Adds a Texture Path to the List of already existing Paths
    255    \param pathName The Path to add.
     254 * Adds a Texture Path to the List of already existing Paths
     255 * @param pathName The Path to add.
    256256*/
    257257void Material::addTexturePath(const char* pathName)
     
    263263
    264264/**
    265    \brief Sets the Materials Diffuse Map
    266    \param dMap the Name of the Image to Use
     265 * Sets the Materials Diffuse Map
     266 * @param dMap the Name of the Image to Use
    267267*/
    268268void Material::setDiffuseMap(const char* dMap)
     
    281281
    282282/**
    283    \brief Sets the Materials Ambient Map
    284    \param aMap the Name of the Image to Use
    285    \todo implement this
     283 * Sets the Materials Ambient Map
     284 * @param aMap the Name of the Image to Use
     285   @todo implement this
    286286*/
    287287void Material::setAmbientMap(const char* aMap)
     
    292292
    293293/**
    294    \brief Sets the Materials Specular Map
    295    \param sMap the Name of the Image to Use
    296    \todo implement this
     294 * Sets the Materials Specular Map
     295 * @param sMap the Name of the Image to Use
     296   @todo implement this
    297297*/
    298298void Material::setSpecularMap(const char* sMap)
     
    303303
    304304/**
    305    \brief Sets the Materials Bumpiness
    306    \param bump the Name of the Image to Use
    307    \todo implemet this
     305 * Sets the Materials Bumpiness
     306 * @param bump the Name of the Image to Use
     307   @todo implemet this
    308308*/
    309309void Material::setBump(const char* bump)
Note: See TracChangeset for help on using the changeset viewer.