Changeset 4470 in orxonox.OLD

Timestamp:

Jun 2, 2005, 1:55:19 AM (19 years ago)

Author:

bensch

Message:

orxonox/trunk: baseobject documented

Location:

orxonox/trunk/src/lib/lang

Files:

• base_object.cc (modified) (5 diffs)
• base_object.h (modified) (4 diffs)

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

@@ -62 +62 @@
 /**
    \brief sets the class identifiers
-   \param a number for the class from class_list.h enumeration
-   \param the class name
+   \param id a number for the class from class_list.h enumeration
+   \param className the class name
 */
 void BaseObject::setClassID(int id, const char* className)
@@ -74 +74 @@
 /**
    \brief sets the class identifier
-   \param a number for the class from class_list.h enumeration
+   \param id a number for the class from class_list.h enumeration
 */
 void BaseObject::setClassID (int id)
@@ -84 +84 @@
 /**
    \brief sets the class identifiers
-   \param the class name
+   \param className the class name
 */
 void BaseObject::setClassName(const char* className)
@@ -92 +92 @@
 
 
-/**
+/*
    \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)
 {
@@ -103 +103 @@
   return true;
 }
-
-
-/*
-  \brief this finalizes an object and makes it ready to be garbage collected
 */
-void BaseObject::finalize()
-{
-  this->finalized = true;
-}
-
 
 /**

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

@@ -1 +1 @@
 /*! 
     \file base_object.h
-    \brief Definition of the base object class. that is a global handler for all classes.
+    \brief Definition of the base object class.
+
+    This is a global handler for all classes.
+
+    \todo isA()
 */
 
@@ -10 +14 @@
 #include "class_list.h"
 #ifndef NULL
-#define NULL 0x0
+#define NULL 0x0        //!< NULL
 #endif
 
@@ -32 +36 @@
   /** \returns the classID of the corresponding Object */
   inline int getClassID(void) const { return this->id; }
-  bool isA (char* className);
+
+  //  bool isA (char* className);
 
   /** \returns if the object is finalized */
   inline bool isFinalized() { return this->finalized; }
-  void finalize();
+  /** \brief this finalizes an object and makes it ready to be garbage collected */
+  void finalize(void) { this->finalized = true; };
 
   void setName (const char* newName);
+  /** \brief returns the Name of this Object */
   const char* getName (void)const { return this->objectName; };
 
@@ -46 +53 @@
   bool           finalized;        //!< is true if the object is ready to be garbage collected
 
-  char*    objectName;                   //!< The name of this object               
+  char*          objectName;       //!< The name of this object               
 };