Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

Changeset 9852 in orxonox.OLD


Ignore:
Timestamp:
Sep 28, 2006, 1:01:03 AM (18 years ago)
Author:
bensch
Message:

orxonox/new_class_id: more doxy-tags

Location:
branches/new_class_id/src/lib/util/loading
Files:
2 edited

Legend:

Unmodified
Added
Removed

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

    r9851 r9852  
    152152  // RESOURCE ITSELF //
    153153  /////////////////////
    154 
    155154  //! A Resource is an Object, that can be loaded from Disk
    156155  /**

  • branches/new_class_id/src/lib/util/loading/resource_manager.cc

    r9848 r9852  
    2525namespace Resources
    2626{
     27  /// Definition of the ResourceManager's ObjectList.
    2728  ObjectListDefinition(ResourceManager);
    2829  //! Singleton Reference to the ResourceManager
    … …  
    5556  }
    5657
    57 
    58 
    59 
     58  /**
     59   * @brief Registers a new Type to the ResourceManager.
     60   * @param type the Type to register.
     61   */
    6062  void ResourceManager::registerType(Resources::Type* type)
    6163  {
    … …  
    6466  }
    6567
     68  /**
     69   * @brief Unregisters a new Type to the ResourceManager.
     70   * @param type the Type to unregister.
     71   */
    6672  void ResourceManager::unregisterType(Resources::Type* type)
    6773  {
    … …  
    7480  }
    7581
    76 
     82  /**
     83   * @brief Sets the main Global path (the main path Resources are searched for)
     84   * @param directory the directory to set.
     85   * @see Resource::locateFile
     86   */
    7787  void ResourceManager::setMainGlobalPath(const Directory& directory)
    7888  {
    … …  
    8191  }
    8292
     93  /**
     94   * @brief add a Global search path. (global paths besided the main path.)
     95   * @param directory a directory to add.
     96   */
    8397  void ResourceManager::addGlobalPath(const Directory& directory)
    8498  {
    … …  
    88102  }
    89103
    90 
     104  /**
     105   * @brief add a ResourcePath to a Type's Paths.
     106   * @param resourceName the Type's name of Resource to add the path to.
     107   * @param pathName pathName the Name of the path to add.
     108   * @return true on success. (if a path was added (no duplicate, and resourceName existed).
     109   */
    91110  bool ResourceManager::addResourcePath(const std::string& resourceName, const std::string& pathName)
    92111  {
    … …  
    99118  }
    100119
     120  /**
     121   * @brief add a ResourcePath to a Type's SubPaths.
     122   * @param resourceName the Type's name of Resource to add the subpath to.
     123   * @param pathName pathName the Name of the path to add.
     124   * @return true on success. (if a path was added (no duplicate, and resourceName existed).
     125   */
    101126  bool ResourceManager::addResourceSubPath(const std::string& resourceName, const std::string& pathName)
    102127  {
    … …  
    109134  }
    110135
    111 
    112 
     136  /**
     137   * @brief checks wether a File is inside of the MainPath.
     138   * @param fileInside the file to check
     139   * @return true if the file is inside.
     140   */
    113141  bool ResourceManager::checkFileInMainPath(const File& fileInside)
    114142  {
    … …  
    116144  }
    117145
     146  /**
     147   * @brief prepends the fileName by the MainGlobalPath (same as mainGlobalPath + '/' + fileName).
     148   * @param fileName The FileName to prepend
     149   * @returns the prepended file-name
     150   */
    118151  std::string ResourceManager::prependAbsoluteMainPath(const std::string& fileName)
    119152  {
    … …  
    121154  }
    122155
    123 
     156  /**
     157   * @brief add a KeepLevelName (this function just counts upwards).
     158   * @param keepLevelName the Name of the KeepLevel to set.
     159   * @returns the Level the Name was set to.
     160   */
    124161  unsigned int ResourceManager::addKeepLevelName(const std::string& keepLevelName)
    125162  {
    … …  
    128165  }
    129166
     167  /**
     168   * @param keepLevelName the Name of the KeepLevel.
     169   * @returns the ID of the KeepLevel named keepLevelName
     170   */
    130171  unsigned int ResourceManager::getKeepLevelID(const std::string& keepLevelName) const
    131172  {
    … …  
    138179  }
    139180
     181  /**
     182   * @param keepLevelID the ID to check.
     183   * @return the name of the KeepLevel.
     184   */
    140185  const std::string& ResourceManager::getKeepLevelName(unsigned int keepLevelID) const
    141186  {
    … …  
    144189  }
    145190
     191
     192  /**
     193   * @brief loads a Resource from a TypeName and a loadString.
     194   * @param resourceTypeName The Name of the Type to what to load a Resource from.
     195   * @param loadString the loadString to load in the Type.
     196   */
    146197  void ResourceManager::loadFromLoadString(const std::string& resourceTypeName, const std::string& loadString)
    147198  {
    … …  
    159210  }
    160211
    161 
     212  /**
     213   * @brief unloads all Resources below a certain threshhold.
     214   * @param keepLevel the KeepLevel below which to erase.
     215   *
     216   * @not Resources will only be erased, if th keepLevel is below, and the resources are not
     217   * referenced anymore.
     218   */
    162219  void ResourceManager::unloadAllBelowKeepLevel(const Resources::KeepLevel& keepLevel)
    163220  {
Note: See TracChangeset for help on using the changeset viewer.