Changeset 4256 in orxonox.OLD for orxonox/branches/levelLoader/src/util/loading/load_param.h

Timestamp:

May 22, 2005, 2:31:08 AM (19 years ago)

Author:

bensch

Message:

orxonox/branches/levelLoader: doxygen-tags

File:

• orxonox/branches/levelLoader/src/util/loading/load_param.h (modified) (4 diffs)

orxonox/branches/levelLoader/src/util/loading/load_param.h

@@ -155 +155 @@
 
 
+//! A class that handles the description of loadable parameters
 class LoadParamDescription
 {
@@ -169 +170 @@
   void print(void) const;
  private:
-  char* paramName;
-  int paramCount;
-  char** types;
-  const char* description;
+  char* paramName;              //!< The name of the parameter
+  int paramCount;               //!< The count of parameters
+  char** types;                 //!< What kind of parameters does this function take ??
+  char* description;            //!< A longer description about this function
 };
 
@@ -187 +188 @@
   static void printAll(void);
 
-  static bool parametersDescription;  
-  static tList<LoadClassDescription>* classList;
+  static bool parametersDescription;             //!< if parameter-description should be enabled.
+  static tList<LoadClassDescription>* classList; //!< a list, that holds all the loadable classes. (after one instance has been loaded)
  private:
-  char* className;
-  tList<LoadParamDescription>* paramList;
+  char* className;                               //!< name of the class
+  tList<LoadParamDescription>* paramList;        //!< List of parameters this class knows.
 };
 
@@ -204 +205 @@
 
  protected:
-  LoadClassDescription* classDesc;
-  LoadParamDescription* paramDesc;
-};
-
-
-// derived template class
+  LoadClassDescription* classDesc;               //!< The LoadClassDescription of this LoadParameter
+  LoadParamDescription* paramDesc;               //!< The LoadParameterDescription of this LoadParameter
+};
+
+
+//! derived template class, so all the Classes can load something.
 template<class T> class LoadParam : public BaseLoadParam
 {