Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

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


Ignore:
Timestamp:
Jul 12, 2005, 12:33:16 AM (19 years ago)
Author:
bensch
Message:

orxonox/trunk: renamed all the \param → @param and so on in Doxygen tags.
Thanks a lot to the kDevelop team. this took since the last commit :)

File:
1 edited

Legend:

Unmodified
Added
Removed

  • orxonox/trunk/src/util/resource_manager.cc

    r4746 r4836  
    4747
    4848/**
    49    \brief standard constructor
     49 * standard constructor
    5050*/
    5151ResourceManager::ResourceManager ()
    … …  
    6464
    6565/**
    66    \brief standard destructor
     66 * standard destructor
    6767*/
    6868ResourceManager::~ResourceManager ()
    … …  
    8787
    8888/**
    89    \brief sets the data main directory
    90    \param dataDir the DataDirectory.
     89 * sets the data main directory
     90 * @param dataDir the DataDirectory.
    9191*/
    9292bool ResourceManager::setDataDir(const char* dataDir)
    … …  
    110110
    111111/**
    112    \brief checks for the DataDirectory, by looking if
    113    \param fileInside is inisde??
     112 * checks for the DataDirectory, by looking if
     113 * @param fileInside is inisde??
    114114*/
    115115bool ResourceManager::checkDataDir(const char* fileInside)
    … …  
    131131#ifndef NO_TEXTURES
    132132/**
    133    \brief adds a new Path for Images
    134    \param imageDir The path to insert
    135    \returns true, if the Path was well and injected (or already existent within the list)
     133 * adds a new Path for Images
     134 * @param imageDir The path to insert
     135 * @returns true, if the Path was well and injected (or already existent within the list)
    136136   false otherwise
    137137*/
    … …  
    171171
    172172/**
    173    \brief loads resources
    174    \param fileName: The fileName of the resource to load
    175    \param prio: The ResourcePriority of this resource (will only be increased)
    176    \param param1: an additional option to parse (see the constuctors for more help)
    177    \param param2: an additional option to parse (see the constuctors for more help)
    178    \param param3: an additional option to parse (see the constuctors for more help)
    179    \returns a pointer to a desired Resource.
     173 * loads resources
     174 * @param fileName: The fileName of the resource to load
     175 * @param prio: The ResourcePriority of this resource (will only be increased)
     176 * @param param1: an additional option to parse (see the constuctors for more help)
     177 * @param param2: an additional option to parse (see the constuctors for more help)
     178 * @param param3: an additional option to parse (see the constuctors for more help)
     179 * @returns a pointer to a desired Resource.
    180180*/
    181181void* ResourceManager::load(const char* fileName, ResourcePriority prio, void* param1, void* param2, void* param3)
    … …  
    228228
    229229/**
    230    \brief loads resources
    231    \param fileName: The fileName of the resource to load
    232    \param type: The Type of Resource to load (\see ResourceType)
    233    \param prio: The ResourcePriority of this resource (will only be increased)
    234    \param param1: an additional option to parse (see the constuctors for more help)
    235    \param param2: an additional option to parse (see the constuctors for more help)
    236    \param param3: an additional option to parse (see the constuctors for more help)
    237    \returns a pointer to a desired Resource.
     230 * loads resources
     231 * @param fileName: The fileName of the resource to load
     232 * @param type: The Type of Resource to load (\see ResourceType)
     233 * @param prio: The ResourcePriority of this resource (will only be increased)
     234 * @param param1: an additional option to parse (see the constuctors for more help)
     235 * @param param2: an additional option to parse (see the constuctors for more help)
     236 * @param param3: an additional option to parse (see the constuctors for more help)
     237 * @returns a pointer to a desired Resource.
    238238*/
    239239void* ResourceManager::load(const char* fileName, ResourceType type, ResourcePriority prio,
    … …  
    400400
    401401/**
    402    \brief unloads a Resource
    403    \param pointer: The pointer to free
    404    \param prio: the PriorityLevel to unload this resource
    405    \returns true if successful (pointer found, and deleted), false otherwise
     402 * unloads a Resource
     403 * @param pointer: The pointer to free
     404 * @param prio: the PriorityLevel to unload this resource
     405 * @returns true if successful (pointer found, and deleted), false otherwise
    406406*/
    407407bool ResourceManager::unload(void* pointer, ResourcePriority prio)
    … …  
    419419
    420420/**
    421    \brief unloads a Resource
    422    \param resource: The resource to unloade
    423    \param prio the PriorityLevel to unload this resource
     421 * unloads a Resource
     422 * @param resource: The resource to unloade
     423 * @param prio the PriorityLevel to unload this resource
    424424*/
    425425bool ResourceManager::unload(Resource* resource, ResourcePriority prio)
    … …  
    478478
    479479/**
    480    \brief unloads all alocated Memory of Resources with a pririty lower than prio
    481    \param prio The priority to delete
     480 * unloads all alocated Memory of Resources with a pririty lower than prio
     481 * @param prio The priority to delete
    482482*/
    483483bool ResourceManager::unloadAllByPriority(ResourcePriority prio)
    … …  
    500500
    501501/**
    502    \brief Searches for a Resource by some information
    503    \param fileName: The name to look for
    504    \param type the Type of resource to locate.
    505    \param param1: an additional option to parse (see the constuctors for more help)
    506    \param param2: an additional option to parse (see the constuctors for more help)
    507    \param param3: an additional option to parse (see the constuctors for more help)
    508    \returns a Pointer to the Resource if found, NULL otherwise.
     502 * Searches for a Resource by some information
     503 * @param fileName: The name to look for
     504 * @param type the Type of resource to locate.
     505 * @param param1: an additional option to parse (see the constuctors for more help)
     506 * @param param2: an additional option to parse (see the constuctors for more help)
     507 * @param param3: an additional option to parse (see the constuctors for more help)
     508 * @returns a Pointer to the Resource if found, NULL otherwise.
    509509*/
    510510Resource* ResourceManager::locateResourceByInfo(const char* fileName, ResourceType type,
    … …  
    587587
    588588/**
    589    \brief Searches for a Resource by Pointer
    590    \param pointer the Pointer to search for
    591    \returns a Pointer to the Resource if found, NULL otherwise.
     589 * Searches for a Resource by Pointer
     590 * @param pointer the Pointer to search for
     591 * @returns a Pointer to the Resource if found, NULL otherwise.
    592592*/
    593593Resource* ResourceManager::locateResourceByPointer(const void* pointer)
    … …  
    610610
    611611/**
    612    \brief Checks if it is a Directory
    613    \param directoryName the Directory to check for
    614    \returns true if it is a directory/symlink false otherwise
     612 * Checks if it is a Directory
     613 * @param directoryName the Directory to check for
     614 * @returns true if it is a directory/symlink false otherwise
    615615*/
    616616bool ResourceManager::isDir(const char* directoryName)
    … …  
    657657
    658658/**
    659    \brief Checks if the file is either a Regular file or a Symlink
    660    \param fileName the File to check for
    661    \returns true if it is a regular file/symlink, false otherwise
     659 * Checks if the file is either a Regular file or a Symlink
     660 * @param fileName the File to check for
     661 * @returns true if it is a regular file/symlink, false otherwise
    662662*/
    663663bool ResourceManager::isFile(const char* fileName)
    … …  
    693693
    694694/**
    695    \brief touches a File on the disk (thereby creating it)
    696    \param fileName The file to touch
     695 * touches a File on the disk (thereby creating it)
     696 * @param fileName The file to touch
    697697*/
    698698bool ResourceManager::touchFile(const char* fileName)
    … …  
    713713
    714714/**
    715    \brief deletes a File from disk
    716    \param fileName the File to delete
     715 * deletes a File from disk
     716 * @param fileName the File to delete
    717717*/
    718718bool ResourceManager::deleteFile(const char* fileName)
    … …  
    726726
    727727/**
    728     \param name the Name of the file to check
    729     \returns The name of the file, including the HomeDir
     728  * @param name the Name of the file to check
     729  * @returns The name of the file, including the HomeDir
    730730    IMPORTANT: this has to be deleted from the outside
    731731*/
    … …  
    755755
    756756/**
    757     \param fileName the Name of the File to check
    758     \returns The full name of the file, including the DataDir, and NULL if the file does not exist
     757  * @param fileName the Name of the File to check
     758  * @returns The full name of the file, including the DataDir, and NULL if the file does not exist
    759759    IMPORTANT: this has to be deleted from the outside
    760760*/
    … …  
    778778
    779779/**
    780    \brief outputs debug information about the ResourceManager
     780 * outputs debug information about the ResourceManager
    781781*/
    782782void ResourceManager::debug() const
Note: See TracChangeset for help on using the changeset viewer.