Changeset 4836 in orxonox.OLD for orxonox/trunk/src/glmenu
- Timestamp:
- Jul 12, 2005, 12:33:16 AM (19 years ago)
-
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/glmenu
- Files:
-
- 2 edited
-
glmenu_imagescreen.cc (modified) (14 diffs)
-
glmenu_imagescreen.h (modified) (2 diffs)
Legend:
- Unmodified
- Added
- Removed
-
orxonox/trunk/src/glmenu/glmenu_imagescreen.cc
r4834 r4836 28 28 using namespace std; 29 29 /** 30 \param root The Element to load the GLMenu from31 */30 * @param root The Element to load the GLMenu from 31 */ 32 32 GLMenuImageScreen::GLMenuImageScreen(const TiXmlElement* root) 33 33 { … … 49 49 50 50 /** 51 \briefLoads a GLMenu from an inputElement52 \param root The Element to load the GLMenu from51 * Loads a GLMenu from an inputElement 52 * @param root The Element to load the GLMenu from 53 53 */ 54 54 void GLMenuImageScreen::loadParams(const TiXmlElement* root) … … 71 71 72 72 /** 73 \briefstandard deconstructor74 \todo this deconstructor is not jet implemented - do it73 * standard deconstructor 74 @todo this deconstructor is not jet implemented - do it 75 75 */ 76 76 GLMenuImageScreen::~GLMenuImageScreen() … … 81 81 82 82 /** 83 \briefsets the background image name84 \param backImageName name of the backgroun-image83 * sets the background image name 84 * @param backImageName name of the backgroun-image 85 85 */ 86 86 void GLMenuImageScreen::setBackgroundImage (const char* backImageName) … … 90 90 91 91 /** 92 \briefsets position of the ImageScreen93 \param offsetX offset from the top left corner in percent(0-1) of the screensize94 \param offsetY offset from the top left corner in percent(0-1) of the screensize92 * sets position of the ImageScreen 93 * @param offsetX offset from the top left corner in percent(0-1) of the screensize 94 * @param offsetY offset from the top left corner in percent(0-1) of the screensize 95 95 */ 96 96 void GLMenuImageScreen::setPosition(float offsetX, float offsetY) … … 102 102 /** 103 103 \brief sets size of the ImageScreen 104 \param scaleX the scaleing of the image into the x-direction (in percent (0-1))105 \param scaleY the scaleing of the image into the y-direction (in percent (0-1))104 * @param scaleX the scaleing of the image into the x-direction (in percent (0-1)) 105 * @param scaleY the scaleing of the image into the y-direction (in percent (0-1)) 106 106 */ 107 107 void GLMenuImageScreen::setScale(float scaleX, float scaleY) … … 113 113 /** 114 114 \brief sets position and size of the ImageScreen 115 \param offsetX offset from the top left corner in percent(0-1) of the screensize116 \param offsetY offset from the top left corner in percent(0-1) of the screensize117 \param scaleX the scaleing of the image into the x-direction (in percent (0-1))118 \param scaleY the scaleing of the image into the y-direction (in percent (0-1))115 * @param offsetX offset from the top left corner in percent(0-1) of the screensize 116 * @param offsetY offset from the top left corner in percent(0-1) of the screensize 117 * @param scaleX the scaleing of the image into the x-direction (in percent (0-1)) 118 * @param scaleY the scaleing of the image into the y-direction (in percent (0-1)) 119 119 */ 120 120 void GLMenuImageScreen::setPosScale(float offsetX, float offsetY, float scaleX, float scaleY) … … 125 125 126 126 /** 127 \param barImage An image for the Bar127 * @param barImage An image for the Bar 128 128 */ 129 129 void GLMenuImageScreen::setBarImage(const char* barImage) … … 133 133 134 134 /** 135 \briefsets the Position and the Size of the bar136 \param barX The Position in the x-direction in percent of the screen (0-1)137 \param barY The Position in the y-direction in percent of the screen (0-1)138 \param barW The Size in the x-direction in percent of the screen (0-1)139 \param barH The Size in the y-direction in percent of the screen (0-1)135 * sets the Position and the Size of the bar 136 * @param barX The Position in the x-direction in percent of the screen (0-1) 137 * @param barY The Position in the y-direction in percent of the screen (0-1) 138 * @param barW The Size in the x-direction in percent of the screen (0-1) 139 * @param barH The Size in the y-direction in percent of the screen (0-1) 140 140 */ 141 141 void GLMenuImageScreen::setBarPosScale(float barX, float barY, float barW, float barH) … … 149 149 150 150 /** 151 \briefset the maximum of countable steps152 \param maxValue of steps151 * set the maximum of countable steps 152 * @param maxValue of steps 153 153 */ 154 154 void GLMenuImageScreen::setMaximum(int maxValue) … … 158 158 159 159 /** 160 \briefset current value161 \param currentValue value to set160 * set current value 161 * @param currentValue value to set 162 162 */ 163 163 void GLMenuImageScreen::setValue(int currentValue) … … 169 169 170 170 /** 171 \briefget the current value171 * get the current value 172 172 */ 173 173 int GLMenuImageScreen::getValue() … … 178 178 179 179 /** 180 \briefcall this to trigger a progress event180 * call this to trigger a progress event 181 181 182 182 this has to redraw the progress bar and the whole image … … 196 196 197 197 /** 198 \briefdraws the ImageScreen to the screenbuffer198 * draws the ImageScreen to the screenbuffer 199 199 */ 200 200 void GLMenuImageScreen::draw () -
orxonox/trunk/src/glmenu/glmenu_imagescreen.h
r4746 r4836 1 1 /*! 2 2 \file glmenu_imagescreen.h 3 \briefclass to display a LoadScreen3 * class to display a LoadScreen 4 4 */ 5 5 … … 31 31 32 32 void setMaximum (int maxValue); 33 /** \returns the maximum of countable steps*/33 /** @returns the maximum of countable steps*/ 34 34 inline int GLMenuImageScreen::getMaximum() const { return this->maxValue; }; 35 35
Note: See TracChangeset
for help on using the changeset viewer.
