Changeset 447 for code/branches/objecthierarchy/src/orxonox/core/CoreIncludes.h

Timestamp:

Dec 9, 2007, 11:21:14 PM (17 years ago)

Author:

landauf

Message:

• added comments and doxygen-tags to the ConfigValueContainer
• changed some comments in the other files

File:

• code/branches/objecthierarchy/src/orxonox/core/CoreIncludes.h (modified) (7 diffs)

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

@@ -1 +1 @@
 /**
     @file CoreIncludes.h
-    @brief Definition of macros for the class-hierarchy and the factory.
+    @brief Definition of macros and typedefs.
 
     Every class needs the RegisterObject(class) macro in its constructor. If the class is an interface
@@ -21 +21 @@
 #include "OgreColourValue.h"
 
+
+// Some typedefs
 namespace orxonox
 {
@@ -27 +29 @@
 }
 
-// Intern macro, containing the common parts of RegisterObject and RegisterRootObject
+
+/**
+    @brief Intern macro, containing the common parts of RegisterObject and RegisterRootObject.
+    @param ClassName The name of the class
+    @param bRootClass True if the class is directly derived from OrxonoxClass
+*/
 #define InternRegisterObject(ClassName, bRootClass) \
     this->setIdentifier(ClassIdentifier<ClassName>::registerClass(this->getParents(), #ClassName, bRootClass)); \
@@ -34 +41 @@
     ClassIdentifier<ClassName>::addObject(this)
 
-// Intern macro, containing the specific part of RegisterRootObject
+/**
+    @brief Intern macro, containing the specific part of RegisterRootObject.
+    @param ClassName The name of the class
+*/
 #define InternRegisterRootObject(ClassName) \
     if (Identifier::isCreatingHierarchy() && !this->getParents()) \
@@ -40 +50 @@
     InternRegisterObject(ClassName, true)
 
-// RegisterObject - with and without debug output
+/**
+    @brief RegisterObject - with and without debug output.
+    @param ClassName The name of the class
+*/
 #if HIERARCHY_VERBOSE
 #define RegisterObject(ClassName) \
@@ -50 +63 @@
 #endif
 
-// RegisterRootObject - with and without debug output
+/**
+    @brief RegisterRootObject - with and without debug output.
+    @param ClassName The name of the class
+*/
 #if HIERARCHY_VERBOSE
 #define RegisterRootObject(ClassName) \
@@ -60 +76 @@
 #endif
 
-// Class(ClassName) returns the Identifier of the given class
+/**
+    @brief Returns the Identifier of the given class.
+    @param ClassName The name of the class
+*/
 #define Class(ClassName) \
     ClassIdentifier<ClassName>::getIdentifier()
 
-// Creates the entry in the Factory
+/**
+    @brief Creates the entry in the Factory.
+    @param ClassName The name of the class
+*/
 #define CreateFactory(ClassName) \
     bool bCreated##ClassName##Factory = ClassFactory<ClassName>::create()
 
-// ID(StringOrInt) returns the Identifier with either a given name or a given NetworkID through the factory
+/**
+    @brief Returns the Identifier with either a given name or a given network ID through the factory.
+    @param StringOrInt The name or the network ID of the class
+*/
 #define ID(StringOrInt) \
     Factory::getIdentifier(StringOrInt)
 
-// bla
+/**
+    @brief Assigns the value, defined in the config-file, to the variable (or the default-value, if there is no entry in the file).
+    @param varname The name of the variable
+    @param defvalue The default-value of the variable
+*/
 #define SetConfigValue(varname, defvalue) \
     ConfigValueContainer* container##varname = this->getIdentifier()->getConfigValueContainer(#varname); \