Changeset 5984 in orxonox.OLD for trunk/src/util/loading/factory.cc

Timestamp:

Dec 8, 2005, 1:09:44 AM (18 years ago)

Author:

bensch

Message:

orxonox/trunk: doxygen in Factory

File:

• trunk/src/util/loading/factory.cc (modified) (5 diffs)

trunk/src/util/loading/factory.cc

@@ -63 +63 @@
 }
 
+/**
+ * deletes all the Factories. (cleanup)
+ */
 void Factory::deleteFactories()
 {
@@ -77 +80 @@
 }
 
+/**
+ * @param classID match a classID with this classID
+ * @returns true on match, false otherwise
+ */
+bool Factory::operator==(ClassID classID) const
+{
+  return (this->classID == classID);
+}
 
 /**
@@ -89 +100 @@
 
 
-BaseObject* Factory::fabricate(const TiXmlElement* root)
+/**
+ * Creates a new Object of type root->Value() (name)
+ * @param root the XML-Root to match for the newly created Object
+ * @returns a new Object of Type root->Value() on match, NULL otherwise
+ */
+ BaseObject* Factory::fabricate(const TiXmlElement* root)
 {
   if (root == NULL || Factory::factoryList == NULL)
@@ -111 +127 @@
 }
 
-BaseObject* Factory::fabricate(const char* className)
+
+/**
+ * Creates a new Object of type className
+ * @param className the ClassName to match for the newly created Object
+ * @returns a new Object of Type className on match, NULL otherwise
+ */
+ BaseObject* Factory::fabricate(const char* className)
 {
   if (className == NULL || Factory::factoryList == NULL)
@@ -133 +155 @@
 }
 
-
+/**
+ * Creates a new Object of type classID
+ * @param classID the ClassID to match for the newly created Object
+ * @returns a new Object of Type classID on match, NULL otherwise
+ */
 BaseObject* Factory::fabricate(ClassID classID)
 {