Changeset 4321 in orxonox.OLD for orxonox/trunk

Timestamp:

May 27, 2005, 1:18:46 AM (20 years ago)

Author:

patrick

Message:

orxonox/trunk: added doxygen tags for the baseobject class

Location:

orxonox/trunk/src/lib/lang

Files:

• base_object.cc (modified) (6 diffs)
• base_object.h (modified) (1 diff)

orxonox/trunk/src/lib/lang/base_object.cc

@@ -30 +30 @@
 {
   this->className = NULL;
+  this->id = -1;
   this->finalized = false;
 }
@@ -42 +43 @@
 }
 
+
+/**
+   \brief sets the class identifiers
+   \param a number for the class from class_list.h enumeration
+   \param the class name
+*/
 void BaseObject::setClassID(int id, const char* className)
 {
@@ -49 +56 @@
 
 
+/**
+   \brief sets the class identifier
+   \param a number for the class from class_list.h enumeration
+*/
 void BaseObject::setClassID (int id)
 {
@@ -54 +65 @@
 }
 
+
+/**
+   \brief sets the class identifiers
+   \param the class name
+*/
 void BaseObject::setClassName(const char* className)
 {
@@ -60 +76 @@
 
 
+/**
+   \brief sets the class identifiers
+   \param a number for the class from class_list.h enumeration
+   \param the class name
+*/
 bool BaseObject::isA (char* className)
 {
@@ -67 +88 @@
 }
 
+
 /*
-bool BaseObject::isFinalized()
-{
-  
-}
+  \brief this finalizes an object and makes it ready to be garbage collected
 */
-
 void BaseObject::finalize()
 {

orxonox/trunk/src/lib/lang/base_object.h

@@ -29 +29 @@
 
  private:
-  const char* className;
-  int id;
-  bool finalized;
+  const char*    className;                       //!< the name of the class 
+  int            id;                              //!< this is the id from the class_list.h enumeration
+  bool           finalized;                       //!< is true if the object is ready to be garbage collected
 };