Changeset 9763 in orxonox.OLD for branches/new_class_id/src/lib/util/loading/load_param.cc

Timestamp:

Sep 19, 2006, 5:18:04 PM (19 years ago)

Author:

bensch

Message:

more doc

File:

• branches/new_class_id/src/lib/util/loading/load_param.cc (modified) (2 diffs)

branches/new_class_id/src/lib/util/loading/load_param.cc

@@ -21 +21 @@
 #include "debug.h"
 /**
- * Constructs a new LoadParameter
+ * @brief Constructs a new LoadParameter
  * @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 executor the Executor, that executes the loading procedure.
+ * @param inLoadCycle If we are in a LoadCycle (loading differs.).
  */
 LoadParamBase::LoadParamBase(const TiXmlElement* root, const std::string& paramName, BaseObject* object, bool inLoadCycle)
@@ -54 +54 @@
 
 
-
+/**
+ * @brief generates a LoadParam based on
+ * @param root the Root Element to load onto the object.
+ * @param paramName the Parameter name that is loaded.
+ * @param object the Object to apply the changes on.
+ * @param executor the Functional Object, that actually executes the function Call.
+ * @param inLoadCycle If we are inside of a loading cycle. (Loading will be different here)
+ */
 CLoadParam::CLoadParam(const TiXmlElement* root, const std::string& paramName, BaseObject* object, Executor<const SubString>* executor, bool inLoadCycle)
     : LoadParamBase(root, paramName, object, inLoadCycle)