Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

Changeset 4321 in orxonox.OLD for orxonox


Ignore:
Timestamp:
May 27, 2005, 1:18:46 AM (19 years ago)
Author:
patrick
Message:

orxonox/trunk: added doxygen tags for the baseobject class

Location:
orxonox/trunk/src/lib/lang
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • orxonox/trunk/src/lib/lang/base_object.cc

    r4320 r4321  
    3030{
    3131  this->className = NULL;
     32  this->id = -1;
    3233  this->finalized = false;
    3334}
     
    4243}
    4344
     45
     46/**
     47   \brief sets the class identifiers
     48   \param a number for the class from class_list.h enumeration
     49   \param the class name
     50*/
    4451void BaseObject::setClassID(int id, const char* className)
    4552{
     
    4956
    5057
     58/**
     59   \brief sets the class identifier
     60   \param a number for the class from class_list.h enumeration
     61*/
    5162void BaseObject::setClassID (int id)
    5263{
     
    5465}
    5566
     67
     68/**
     69   \brief sets the class identifiers
     70   \param the class name
     71*/
    5672void BaseObject::setClassName(const char* className)
    5773{
     
    6076
    6177
     78/**
     79   \brief sets the class identifiers
     80   \param a number for the class from class_list.h enumeration
     81   \param the class name
     82*/
    6283bool BaseObject::isA (char* className)
    6384{
     
    6788}
    6889
     90
    6991/*
    70 bool BaseObject::isFinalized()
    71 {
    72  
    73 }
     92  \brief this finalizes an object and makes it ready to be garbage collected
    7493*/
    75 
    7694void BaseObject::finalize()
    7795{
  • orxonox/trunk/src/lib/lang/base_object.h

    r4320 r4321  
    2929
    3030 private:
    31   const char* className;
    32   int id;
    33   bool finalized;
     31  const char*    className;                       //!< the name of the class
     32  int            id;                              //!< this is the id from the class_list.h enumeration
     33  bool           finalized;                       //!< is true if the object is ready to be garbage collected
    3434};
    3535
Note: See TracChangeset for help on using the changeset viewer.