Changeset 9802 in orxonox.OLD for branches/new_class_id/src/lib/util/loading/new_resource_manager.h

Timestamp:

Sep 24, 2006, 12:31:38 PM (18 years ago)

Author:

bensch

Message:

new_class_id: more doxy-tags, and some default values

File:

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

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

@@ -19 +19 @@
     /** @returns a Pointer to the only object of this Class */
     inline static NewResourceManager* getInstance() { if (!_singletonRef) _singletonRef = new NewResourceManager();  return _singletonRef; };
-  inline static void deleteInstance() { if (_singletonRef) delete _singletonRef; };
+    /** @brief deletes the Instance if it exists. */
+    inline static void deleteInstance() { if (_singletonRef) delete _singletonRef; };
 
 
@@ -34 +35 @@
     const std::string& getKeepLevelName(unsigned int keepLevelID) const;
 
-  const std::vector<Resources::Type*> resourceTypes() const { return _resourceTypes; };
+    /** @returns the Types of Resources */
+    const std::vector<Resources::Type*> resourceTypes() const { return _resourceTypes; };
+    /** @returns the main global search Path */
     const Directory& mainGlobalPath() const { return _mainGlobalPath; };
     /** @returns all global paths without mainGlobalPath */
@@ -56 +59 @@
     static NewResourceManager*         _singletonRef;       //!< singleton Reference
 
-    std::vector<Resources::Type*>      _resourceTypes;
-    //! GLOBALS
-    Directory                          _mainGlobalPath;
-    std::vector<Directory>             _globalPaths;
+    Directory                          _mainGlobalPath;     //!< The main include directory (default at "./")
+    std::vector<Directory>             _globalPaths;        //!< Additional Global include directories.
 
-    std::vector<std::string>           _keepLevelNames;
+    std::vector<Resources::Type*>      _resourceTypes;      //!< A Vector of all the stored ResourceTypes @see Resources::Type
+    std::vector<std::string>           _keepLevelNames;     //!< Names of KeepLevels @see Resources::KeepLevel
   };