Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

Changeset 5984 in orxonox.OLD for trunk


Ignore:
Timestamp:
Dec 8, 2005, 1:09:44 AM (19 years ago)
Author:
bensch
Message:

orxonox/trunk: doxygen in Factory

Location:
trunk/src/util/loading
Files:
2 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/util/loading/factory.cc

    r5982 r5984  
    6363}
    6464
     65/**
     66 * deletes all the Factories. (cleanup)
     67 */
    6568void Factory::deleteFactories()
    6669{
    … …  
    7780}
    7881
     82/**
     83 * @param classID match a classID with this classID
     84 * @returns true on match, false otherwise
     85 */
     86bool Factory::operator==(ClassID classID) const
     87{
     88  return (this->classID == classID);
     89}
    7990
    8091/**
    … …  
    89100
    90101
    91 BaseObject* Factory::fabricate(const TiXmlElement* root)
     102/**
     103 * Creates a new Object of type root->Value() (name)
     104 * @param root the XML-Root to match for the newly created Object
     105 * @returns a new Object of Type root->Value() on match, NULL otherwise
     106 */
     107 BaseObject* Factory::fabricate(const TiXmlElement* root)
    92108{
    93109  if (root == NULL || Factory::factoryList == NULL)
    … …  
    111127}
    112128
    113 BaseObject* Factory::fabricate(const char* className)
     129
     130/**
     131 * Creates a new Object of type className
     132 * @param className the ClassName to match for the newly created Object
     133 * @returns a new Object of Type className on match, NULL otherwise
     134 */
     135 BaseObject* Factory::fabricate(const char* className)
    114136{
    115137  if (className == NULL || Factory::factoryList == NULL)
    … …  
    133155}
    134156
    135 
     157/**
     158 * Creates a new Object of type classID
     159 * @param classID the ClassID to match for the newly created Object
     160 * @returns a new Object of Type classID on match, NULL otherwise
     161 */
    136162BaseObject* Factory::fabricate(ClassID classID)
    137163{

  • trunk/src/util/loading/factory.h

    r5982 r5984  
    5050  static  BaseObject* fabricate(const TiXmlElement* root = NULL);
    5151
    52   bool operator==(ClassID classID) const { return (this->classID == classID); };
     52
     53  bool operator==(ClassID classID) const;
    5354  bool operator==(const char* className) const;
    5455
    … …  
    6970{
    7071 public:
     72 /**
     73  * creates a new type Factory to enable the loading of T
     74  * @param factoryName the Name of the Factory to load.
     75  * @param classID the ID of the Class to be created.
     76  */
    7177  tFactory (const char* factoryName, ClassID classID)
    7278   : Factory(factoryName, classID)
    73   {
    74   }
     79  {  }
    7580
    7681  private:
Note: See TracChangeset for help on using the changeset viewer.