Context Navigation

Changeset 9776 in orxonox.OLD

Timestamp:

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

Author:

bensch

Message:

doxy

Location:

branches/new_class_id/src/lib/util/loading

Files:

-                      r9775
+                      r9776
  * @param root the XML-element to load this Parameter from
  * @param paramName the Parameter to load
- * @param object the BaseObject, to load this parameter on to (will be cast to executor's Parameter)
  * @param inLoadCycle If we are in a LoadCycle (loading differs.).
  */
 …
 /**
+ * @param classID the ID of the class. This is needed to identify into what class this Parameter belongs.
  * @param descriptionText The text to set as a description for this Parameter
  * @returns a pointer to itself.

-                      r9771
+                      r9776
                             const MultiType& value4 = MT_NULL)
   { this->executor->defaultValues(value0, value1, value2, value3, value4); return *this;  };
+  //! Describes a LoadParam
   CLoadParam& describe(const std::string& descriptionText) { LoadParamBase::describe(OperateClass::staticClassID(), descriptionText); return *this; };
   //     CLoadParam& attribute(const std::string& attributeName, const Executor<SubString>& executor);
 …
 private:
   Executor<const SubString, OperateClass>*         executor;            //!< The Executor, that actually executes the Loading process.
   OperateClass*                                    object;
+  OperateClass*                                    object;              //!< The Object this LoadParam operates on.
 };

-                      r9775
+                      r9776
 { }
 /**
  *  deletes a classDescription (deletes all the parameterDescriptions as well
+ * @brief clears all LoadParamDescriptions.
  */
-LoadParamClassDescription::~LoadParamClassDescription()
-{}
 void LoadParamClassDescription::deleteAllDescriptions()
+{
 …
+/**
+ * @brief describes a LoadParam-parameter.
+ * @param classID the ID of the class.
+ * @param paramName the Name of the Parameter.
+ * @param descriptionText the Test to set.
+ */
 void LoadParamClassDescription::describeClass(const ClassID& classID,
     const std::string& paramName,
 …
+}
+/**
+ * @brief sets Values of the specified LoadParam-parameter.
+ * @param classID the ID of the class.
+ * @param paramName the name of the Parameter.
+ * @param paramCount the count of Parameters this LoadParam takes.
+ * @param defaultValues the default Values.
+ * @param retVal if the Parameter takes return Values.
+ */
 void LoadParamClassDescription::setValuesOf(const ClassID& classID,
     const std::string& paramName,

-                      r9775
+                      r9776
 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; }
 …
                           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; };
 …
 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;

-                      r9775
+                      r9776
 /**
+ * @brief Creates a Description of a LoadParam
  * @param paramName the name of the parameter to load
  */
 …
     : _name(paramName), _parameterCount(0)
 { }
-/**
- *  removes all the alocated memory
- */
-LoadParamDescription::~LoadParamDescription()
-{}
 /**
 …
+}
+/**
+ * @brief sets the Values of the LoadParam in the Description.
+ * @param paramCount the count of arguments the underlying paramDescription takes.
+ * @param defaultValues the default Values the underlying parameter takes.
+ * @param retVal if the underlying parameter has a return value
+ */
 void LoadParamDescription::setValues(unsigned int paramCount,
                                      const MultiType* const defaultValues,

-                      r9772
+                      r9776
 public:
   LoadParamDescription(const std::string& paramName = "");
-  ~LoadParamDescription();
+  //! Compares a LoadParamDescription with a String.
   bool operator==(const std::string& paramName) const { return this->_name == paramName; };
+  //! Compares two LoadParamDescription
   bool operator==(const LoadParamDescription& paramDescr) const { return this->_name == paramDescr._name; };
+  //! Compares two LoadParamDescription with the less operator
   bool operator<(const LoadParamDescription& paramDescr) const { return this->_name < paramDescr._name; };
 …
   std::string                _description;           //!< A longer description about this function.
   std::vector<std::string>   _types;
   std::vector<std::string>   _defaultValues;
+  std::vector<std::string>   _types;                 //!< A Vector of types of this Parameter.
+  std::vector<std::string>   _defaultValues;         //!< A Vector of defaultValues of this Parameter.
 };

Note: See TracChangeset for help on using the changeset viewer.