Changeset 7297 for code/branches/doc/src/libraries/core/BaseObject.cc

Timestamp:

Aug 31, 2010, 8:37:29 PM (15 years ago)

Author:

landauf

Message:

fixed lots of Doxygen warnings

Note: Doxygen prints a warning if only a part of the parameters of a function are documented.

Added documentation for missing parameters (as good as I could), removed documentation of obsolete parameters and fixed names of renamed parameters.
Some parameters are tagged with "FIXME", please replace this with an appropriate documentation if you know what it does.

File:

• code/branches/doc/src/libraries/core/BaseObject.cc (modified) (2 diffs)

code/branches/doc/src/libraries/core/BaseObject.cc

@@ -116 +116 @@
         @brief XML loading and saving.
         @param xmlelement The XML-element
-        @param loading Loading (true) or saving (false)
+        @param mode The mode defines the operation that is being executed: loading or saving the object (from or to XML respectively)
     */
     void BaseObject::XMLPort(Element& xmlelement, XMLPort::Mode mode)
@@ -141 +141 @@
         @brief Defines the possible event states of this object and parses eventsources from an XML file.
         @param xmlelement The XML-element
-        @param loading Loading (true) or saving (false)
+        @param mode The mode defines the operation that is being executed: loading or saving the object (from or to XML respectively)
     */
     void BaseObject::XMLEventPort(Element& xmlelement, XMLPort::Mode mode)