Changeset 365 for code/branches/objecthierarchy/src/orxonox/core/Factory.cc

Timestamp:

Dec 1, 2007, 4:24:56 AM (16 years ago)

Author:

landauf

Message:

added comments

File:

• code/branches/objecthierarchy/src/orxonox/core/Factory.cc (modified) (5 diffs)

code/branches/objecthierarchy/src/orxonox/core/Factory.cc

@@ +1 @@
+/*!
+    @file Factory.cc
+    @brief Implementation of the Factory class.
+*/
+
 #include "Factory.h"
 #include "Identifier.h"
@@ -4 +9 @@
 namespace orxonox
 {
-    Factory* Factory::pointer_s = NULL;
+    Factory* Factory::pointer_s = NULL; // Set the static member variable pointer_s to zero
 
+    /**
+        @returns the Identifier with a given name.
+        @param name The name of the wanted Identifier
+    */
     Identifier* Factory::getIdentifier(const std::string& name)
     {
@@ -14 +23 @@
     }
 
+    /**
+        @returns the Identifier with a given networkID.
+        @param id The networkID of the wanted Identifier
+    */
     Identifier* Factory::getIdentifier(const unsigned int id)
     {
@@ -22 +35 @@
     }
 
+    /**
+        @brief Adds a new Identifier to both maps.
+        @param name The name of the identifier
+        @param identifier The identifier to add
+    */
     void Factory::add(const std::string& name, Identifier* identifier)
     {
@@ -31 +49 @@
     }
 
+    /**
+        @brief Removes the entry with the old networkID and adds a new one.
+        @param identifier The identifier to change
+        @param oldID The old networkID
+        @param newID The new networkID
+    */
     void Factory::changeNetworkID(Identifier* identifier, const unsigned int oldID, const unsigned int newID)
     {