Changeset 9850 in orxonox.OLD for branches/new_class_id/src/lib/util/loading/resource.h

Timestamp:

Sep 28, 2006, 12:16:37 AM (18 years ago)

Author:

bensch

Message:

new_class_id: doxy-tags

File:

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

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

@@ -14 +14 @@
 #include "filesys/directory.h"
 
+//! A Namespace Resources and ResourceHandling is defined in.
 namespace Resources
 {
@@ -29 +30 @@
     KeepLevel(const std::string& keepLevelName);
 
+    //! Compare equality
     inline bool operator==(const KeepLevel& keepLevel) const { return this->_keepLevel == keepLevel._keepLevel; };
+    //! Compares inequality
     inline bool operator!=(const KeepLevel& keepLevel) const { return this->_keepLevel != keepLevel._keepLevel; };
+    //! Compares less/equal than
     inline bool operator<=(const KeepLevel& keepLevel) const { return this->_keepLevel <= keepLevel._keepLevel; };
+    //! Compares less than
     inline bool operator<(const KeepLevel& keepLevel) const { return this->_keepLevel < keepLevel._keepLevel; };
 
-    /** @returns the KeepLevel */
+    /** @returns the KeepLevel as a number */
     inline unsigned int keepLevel() const { return _keepLevel; };
     const std::string& name() const;
@@ -85 +90 @@
   public:
     virtual ~Type();
-    /** @returns true if the names match @param resourceName the Name to compare. @brief compare the Type with a Name */
-    bool operator==(const std::string& resourceName) const { return this->_typeName == resourceName; };
+    /** @returns true if the names match @param typeName the Name to compare. @brief compare the Type with a Name */
+    bool operator==(const std::string& typeName) const { return this->_typeName == typeName; };
 
     void addExtension(const std::string& extension);