Changeset 7297 for code/branches/doc/src/libraries/tools

Timestamp:

Aug 31, 2010, 8:37:29 PM (14 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.

Location:

code/branches/doc/src/libraries/tools

Files:

• ResourceCollection.cc (modified) (1 diff)
• ResourceCollection.h (modified) (1 diff)
• ResourceLocation.cc (modified) (1 diff)
• ResourceLocation.h (modified) (1 diff)
• Timer.cc (modified) (1 diff)
• Timer.h (modified) (1 diff)

code/branches/doc/src/libraries/tools/ResourceCollection.cc

@@ -52 +52 @@
     }
 
-    void ResourceCollection::XMLPort(Element& xmlElement, XMLPort::Mode mode)
+    void ResourceCollection::XMLPort(Element& xmlelement, XMLPort::Mode mode)
     {
-        XMLPortParam(ResourceCollection, "resourceGroup", setResourceGroup, getResourceGroup, xmlElement, mode);
-        XMLPortObject(ResourceCollection, ResourceLocation, "", addResourceLocation, getResourceLocation, xmlElement, mode);
+        XMLPortParam(ResourceCollection, "resourceGroup", setResourceGroup, getResourceGroup, xmlelement, mode);
+        XMLPortObject(ResourceCollection, ResourceLocation, "", addResourceLocation, getResourceLocation, xmlelement, mode);
     }
 

code/branches/doc/src/libraries/tools/ResourceCollection.h

@@ -44 +44 @@
         virtual ~ResourceCollection();
 
-        virtual void XMLPort(Element& xmlElement, XMLPort::Mode mode);
+        virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode);
 
         void setResourceGroup(const std::string& resourceGroup);

code/branches/doc/src/libraries/tools/ResourceLocation.cc

@@ -56 +56 @@
     }
 
-    void ResourceLocation::XMLPort(Element& xmlElement, XMLPort::Mode mode)
+    void ResourceLocation::XMLPort(Element& xmlelement, XMLPort::Mode mode)
     {
-        XMLPortParam(ResourceLocation, "path",        setPath,        getPath,        xmlElement, mode);
-        XMLPortParam(ResourceLocation, "archiveType", setArchiveType, getArchiveType, xmlElement, mode);
-        XMLPortParam(ResourceLocation, "recursive",   setRecursive,   getRecursive,   xmlElement, mode);
+        XMLPortParam(ResourceLocation, "path",        setPath,        getPath,        xmlelement, mode);
+        XMLPortParam(ResourceLocation, "archiveType", setArchiveType, getArchiveType, xmlelement, mode);
+        XMLPortParam(ResourceLocation, "recursive",   setRecursive,   getRecursive,   xmlelement, mode);
         if (path_.empty())
             ThrowException(AbortLoading, "ResourceLocation: No path given.");

code/branches/doc/src/libraries/tools/ResourceLocation.h

@@ -46 +46 @@
         virtual ~ResourceLocation();
 
-        virtual void XMLPort(Element& xmlElement, XMLPort::Mode mode);
+        virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode);
 
         void setPath(const std::string& path) { path_ = path; }

code/branches/doc/src/libraries/tools/Timer.cc

@@ -95 +95 @@
         @param interval The timer-interval in seconds
         @param bLoop If true, the function gets called every 'interval' seconds
-        @param exeuctor A executor of the function to call
+        @param executor A executor of the function to call
+        @param bKillAfterCall If true, the timer will be deleted after the function was executed
     */
     Timer::Timer(float interval, bool bLoop, const ExecutorPtr& executor, bool bKillAfterCall)

code/branches/doc/src/libraries/tools/Timer.h

@@ -85 +85 @@
                 @param interval The timer-interval in seconds
                 @param bLoop If true, the function gets called every 'interval' seconds
-                @param object The object owning the timer and the function
                 @param executor A executor of the function to call
+                @param bKillAfterCall If true, the timer will be deleted after the function was executed
             */
             void setTimer(float interval, bool bLoop, const ExecutorPtr& executor, bool bKillAfterCall = false)