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

Timestamp:

Jun 3, 2005, 12:56:57 AM (19 years ago)

Author:

bensch

Message:

orxonox/trunk: more doxygen-tags in util

File:

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

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

@@ -30 +30 @@
    set everything to zero and define factoryName
 */
-Factory::Factory (const char* name)
+Factory::Factory (const char* factoryName)
 {
   this->factoryName = NULL;
-  this->setFactoryName(name);
+  this->setFactoryName(factoryName);
   next = NULL;
   
@@ -51 +51 @@
   if (this->next)
     delete this->next;
+
+  if (this->factoryName)
+    delete []this->factoryName;
 }
 
-void Factory::setFactoryName(const char* name)
+/**
+   \brief sets the name of this factory
+*/
+void Factory::setFactoryName(const char* factoryName)
 {
-  if (factoryName)
-    delete factoryName;
-  factoryName = new char[strlen(name)+1];
-  strcpy(factoryName, name);
+  if (this->factoryName)
+    delete this->factoryName;
+  this->factoryName = new char[strlen(factoryName)+1];
+  strcpy(this->factoryName, factoryName);
 }
 
@@ -88 +94 @@
 }
 
-const char* grabParameter(const TiXmlElement* root, const char* name)
+/**
+   \param root: The XML-element to grab a parameter from
+   \param parameterName: the parameter to grab
+   \returns the Value of the parameter if found, NULL otherwise
+*/
+const char* grabParameter(const TiXmlElement* root, const char* parameterName)
 {
   const TiXmlElement* element;
@@ -95 +106 @@
   if (root == NULL)
     return NULL;
-  assert( name != NULL);
+  assert( parameterName != NULL);
         
-  element = root->FirstChildElement( name);
+  element = root->FirstChildElement( parameterName);
   if( element == NULL) return NULL;