Changeset 9776 in orxonox.OLD for branches/new_class_id/src/lib/util/loading/load_param_class_description.h

Timestamp:

Sep 20, 2006, 12:17:44 AM (18 years ago)

Author:

bensch

Message:

doxy

File:

• branches/new_class_id/src/lib/util/loading/load_param_class_description.h (modified) (3 diffs)

branches/new_class_id/src/lib/util/loading/load_param_class_description.h

@@ -34 +34 @@
 public:
   LoadParamClassDescription(const std::string& className = "");
-  ~LoadParamClassDescription();
 
+  //! Compares a LoadParamClassDescription with a String.
   bool operator==(const std::string& className) const { return this->_className == className; };
+  //! Compares two LoadParamClassDescription with each other
   bool operator==(const LoadParamClassDescription& classDescr) const { return this->_className == classDescr._className; };
+  //! Compares two LoadParamClassDescription with each other, using the less operator
   bool operator<(const LoadParamClassDescription& classDescr) const { return this->_className < classDescr._className; }
 
@@ -50 +52 @@
                           bool retVal = false);
 
-
+  /** @param createThem: if the Parameters should be created/stored. */
   static void createDescriptions(bool createThem) { _createParametersDescription = createThem; };
+  /** @returns if the Parameters are created/stored. */
   static bool createsDescriptions() { return _createParametersDescription; };
 
@@ -59 +62 @@
 
 private:
+  //! A Type definition for the Map of Class Descriptions
   typedef std::map<ClassID, LoadParamClassDescription>  ClassDescriptionMap;
+  //! A type definition for the Map of Parameter Descriptions inside of Class-descriptions.
   typedef std::map<std::string, LoadParamDescription>   ParamDescriptionMap;