Changeset 4023 in orxonox.OLD

Timestamp:

May 3, 2005, 1:48:38 AM (19 years ago)

Author:

bensch

Message:

orxonox/trunk: doxygen tags

Location:

orxonox/trunk/src/lib/graphics/importer

Files:

• model.cc (modified) (7 diffs)
• model.h (modified) (2 diffs)

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

@@ -31 +31 @@
 /// SUB-Elements ///
 ////////////////////
+/**
+   \brief creates a new ModelFaceElement
+*/
 ModelFaceElement::ModelFaceElement()
-{
-}
-
+{}
+
+/**
+   \brief destroys a ModelFaceElement
+*/
 ModelFaceElement::~ModelFaceElement()
 {
@@ -41 +46 @@
 }
 
+/**
+   \brief creates a new ModelFace
+*/
 ModelFace::ModelFace()
 {
@@ -53 +61 @@
 }
 
+/**
+   \brief deletes a ModelFace
+*/
 ModelFace::~ModelFace()
 {
@@ -69 +80 @@
 }
 
+/**
+   \brief Creates a new ModelGroup
+*/
 ModelGroup::ModelGroup()
 {
@@ -81 +95 @@
 }
 
+/**
+   \brief deletes a ModelGroup
+*/
 ModelGroup::~ModelGroup()
 {
@@ -93 +110 @@
 }
 
+/**
+   \brief cleans up a ModelGroup
+
+   actually does the same as the delete Operator, but does not delete the predecessing group
+*/
 void ModelGroup::cleanup(void)
 {
+  PRINTF(5)("Cleaning up group\n");
   if (this->firstFace)
     delete this->firstFace;
@@ -344 +367 @@
 /**
    \brief adds a new Material to the Material List
-   \param material the name of the Material to add
+   \param materialName the name of the Material to add
    \returns the added material
 */

orxonox/trunk/src/lib/graphics/importer/model.h

@@ -96 +96 @@
 
   char* name;                 //!< This is the name of the Model.
-  MODEL_TYPE type;
+  MODEL_TYPE type;            //!< A type for the Model
   bool finalized;             //!< Sets the Object to be finalized.
 
@@ -133 +133 @@
 
   void setName(const char* name);
+  /** \returns the Name of the Model */
   inline const char* getName() {return this->name;}