Changeset 4465 in orxonox.OLD for orxonox/trunk/src/util/resource_manager.cc

Timestamp:

Jun 2, 2005, 1:21:18 AM (19 years ago)

Author:

bensch

Message:

orxonox/trunk: resource manager in new design
no no just kidding… only doxy-tags

File:

• orxonox/trunk/src/util/resource_manager.cc (modified) (6 diffs)

orxonox/trunk/src/util/resource_manager.cc

@@ -167 +167 @@
 /**
    \brief loads resources
-   \param fileName The fileName of the resource to load
-   \param prio The ResourcePriority of this resource (will only be increased)
+   \param fileName: The fileName of the resource to load
+   \param prio: The ResourcePriority of this resource (will only be increased)
+   \param param1: an additional option to parse (see the constuctors for more help)
+   \param param2: an additional option to parse (see the constuctors for more help)
+   \param param3: an additional option to parse (see the constuctors for more help)
    \returns a pointer to a desired Resource.
 */
@@ -201 +204 @@
 /**
    \brief loads resources
-   \param fileName The fileName of the resource to load
-   \param type The Type of Resource to load (\see ResourceType)
-   \param prio The ResourcePriority of this resource (will only be increased)
+   \param fileName: The fileName of the resource to load
+   \param type: The Type of Resource to load (\see ResourceType)
+   \param prio: The ResourcePriority of this resource (will only be increased)
+   \param param1: an additional option to parse (see the constuctors for more help)
+   \param param2: an additional option to parse (see the constuctors for more help)
+   \param param3: an additional option to parse (see the constuctors for more help)
    \returns a pointer to a desired Resource.
 */
-void* ResourceManager::load(const char* fileName, ResourceType type, ResourcePriority prio, void* param1, void* param2, void* param3)
+void* ResourceManager::load(const char* fileName, ResourceType type, ResourcePriority prio,
+                            void* param1, void* param2, void* param3)
 {
   // searching if the resource was loaded before.
@@ -357 +364 @@
 /**
    \brief unloads a Resource
-   \param pointer The pointer to free
+   \param pointer: The pointer to free
+   \param prio: the PriorityLevel to unload this resource
    \returns true if successful (pointer found, and deleted), false otherwise
-   
 */
 bool ResourceManager::unload(void* pointer, ResourcePriority prio)
@@ -374 +381 @@
 }
 
+/**
+   \brief unloads a Resource
+   \param resource: The resource to unloade
+   \param prio the PriorityLevel to unload this resource
+*/
 bool ResourceManager::unload(Resource* resource, ResourcePriority prio)
 {
@@ -441 +453 @@
 /**
    \brief Searches for a Resource by some information
-   \param fileName The name to look for
+   \param fileName: The name to look for
+   \param type the Type of resource to locate.
+   \param param1: an additional option to parse (see the constuctors for more help)
+   \param param2: an additional option to parse (see the constuctors for more help)
+   \param param3: an additional option to parse (see the constuctors for more help)
    \returns a Pointer to the Resource if found, NULL otherwise.
 */
@@ -659 +675 @@
 
 /** 
-    \param fileName the Name of the file to check
+    \param name the Name of the file to check
     \returns The name of the file, including the HomeDir
     IMPORTANT: this has to be deleted from the outside