Changeset 365 for code/branches/objecthierarchy/src/orxonox/core/IdentifierList.h

Timestamp:

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

Author:

landauf

Message:

added comments

File:

• code/branches/objecthierarchy/src/orxonox/core/IdentifierList.h (modified) (3 diffs)

code/branches/objecthierarchy/src/orxonox/core/IdentifierList.h

@@ -1 +1 @@
 #ifndef _IdentifierList_H__
+/*!
+    @file IdentifierList.h
+    @brief Definition of the IdentifierList class
+
+    The IdentifierList is a single-linked list, containing Identifiers.
+    The IdentifierList is used to store parents and childs of each Identifier.
+*/
+
 #define _IdentifierList_H__
 
@@ -6 +14 @@
 namespace orxonox
 {
-    class Identifier;
+    class Identifier; // Forward declaration
 
+    //! The list-element of the IdentifierList
     class IdentifierListElement
     {
         public:
             IdentifierListElement(const Identifier* identifier);
-            ~IdentifierListElement();
 
-            const Identifier* identifier_;
-            IdentifierListElement* next_;
+            const Identifier* identifier_;      //!< The identifier
+            IdentifierListElement* next_;       //!< The next element in the list
     };
 
+    //! The IdentifierList contains Identifiers
     class IdentifierList
     {
@@ -28 +37 @@
             std::string toString() const;
 
-            IdentifierListElement* first_;
+            IdentifierListElement* first_;      //!< The first element in the list
     };
 }