Changeset 4461 in orxonox.OLD for orxonox/trunk/src/lib/graphics/importer/md2Model.cc

Timestamp:

Jun 2, 2005, 12:32:34 AM (19 years ago)

Author:

patrick

Message:

orxonox/trunk: documented the md2 class correctly now

File:

• orxonox/trunk/src/lib/graphics/importer/md2Model.cc (modified) (13 diffs)

orxonox/trunk/src/lib/graphics/importer/md2Model.cc

@@ -75 +75 @@
  ********************************************************************************/
 
-/*
+/**
   \brief simple constructor initializing all variables
 */
@@ -87 +87 @@
 }
 
-/*
+/**
   \brief simple destructor, dereferencing all variables
 
@@ -122 +122 @@
 
 
-/*
+/**
   \brief sets the animation type
   \param type: animation type
@@ -146 +146 @@
 
 
-/*
+/**
   \brief sets the time in seconds passed since the last tick
   \param time: in sec
@@ -156 +156 @@
 
 
-/*
+/**
   \brief draws the model: interface for all other classes out in the world
 */
@@ -172 +172 @@
 
 
-/*
+/**
   \brief this is an internal function to render this special frame selected by animate()
 */
@@ -216 +216 @@
 
 
-/*
+/**
   \brief animates the current model
 
@@ -243 +243 @@
 
 
-/*
+/**
   \brief this is how id is precessing their lightning
 
@@ -253 +253 @@
 }
 
-/*
+
+/**
   \brief prints out debug informations
 */
@@ -273 +274 @@
  ********************************************************************************/
 
-/*
+/**
   \brief simple constructor
 */
@@ -293 +294 @@
 
 
-/*
+/**
   \brief simple destructor
 
@@ -312 +313 @@
 
 
-/*
+/**
   \brief this will load the whole model data (vertices, opengl command list, ...)
-  \param fileName to the model file
+  \param fileName: the name of the model file
   \return true if success
 */
@@ -382 +383 @@
 
 
-/*
+/**
   \brief loads the skin/material stuff
-  \param fileName of the skin file
+  \param fileName: name of the skin file
   \return true if success
 */