Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

Changeset 7396 in orxonox.OLD for trunk/src/lib/lang


Ignore:
Timestamp:
Apr 27, 2006, 4:00:04 PM (19 years ago)
Author:
bensch
Message:

brief

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/lib/lang/class_list.cc

    r7221 r7396  
    3535
    3636/**
    37  * Creates a new ClassList
     37 * @brief Creates a new ClassList
    3838*/
    3939ClassList::ClassList(ClassID classID, unsigned long classIDFull, const std::string& className)
     
    4545
    4646/**
    47  * standard deconstructor
     47 * @brief standard deconstructor
    4848*/
    4949ClassList::~ClassList ()
     
    8989
    9090/**
    91  * removes an Object from a the ClassList
     91 * @brief removes an Object from a the ClassList
    9292 * @param objectPointer the Object to delete from the List
    9393 */
     
    107107
    108108/**
    109  * grabs the names of all Classes, and injects it into a List of const chars
     109 * @brief grabs the names of all Classes, and injects it into a List of const chars
    110110 * @return the generated List
    111111 *
     
    128128
    129129/**
    130  * searches for classID and returns the list of Entities
     130 * @brief searches for classID and returns the list of Entities
    131131 * @param classID the ID of the class to get the list from
    132132 * @return the List accessed by classID, or NULL if not found
     
    151151
    152152/**
    153  * searches for className and returns the list of Entities
     153 * @brief searches for className and returns the list of Entities
    154154 * @param className the name of the class to get the list from
    155155 * @return the List accessed by classID, or NULL if not found
     
    201201
    202202/**
    203  * checks if the BaseObject* object exists.
     203 * @brief checks if the BaseObject* object exists.
    204204 * @param objectName the name of the BaseObject to look for
    205205 * @param classID if not CL_NULL it will only search through a specific type of Objects. Otherwise it will be searched everywhere.
     
    236236
    237237/**
    238  * checks if the BaseObject* object exists.
     238 * @brief checks if the BaseObject* object exists.
    239239 * @param object the Pointer to a BaseObject to check if it exists
    240240 * @param classID if not CL_NULL it will only search through a specific type of Objects. Otherwise it will be searched everywhere.
     
    267267
    268268/**
    269  * prints out a string of all the types this Object matches
     269 * @brief prints out a string of all the types this Object matches
    270270 * @param object a Pointer to the object to analyze
    271271 */
     
    281281
    282282/**
    283  * converts a ClassID into a string
     283 * @brief converts a ClassID into a string
    284284 * @param classID the ClassID to search for
    285285 * @return a String containing the name of the Class, NULL if the Class was not found
     
    294294
    295295/**
    296  * converts a String into a ClassID
     296 * @brief converts a String into a ClassID
    297297 * @param className the name of the class to search for
    298298 * @return the ClassID. CL_NULL, if the class was not found.
     
    305305
    306306/**
    307  * checks if this ClassList is named className
     307 * @brief checks if this ClassList is named className
    308308 * @param className the Name to check this ClassList's ClassName against
    309309 * @returns true on match, false otherwise
     
    317317
    318318/**
    319  * Print out some very nice debug information
     319 * @brief Print out some very nice debug information
    320320 * @param debugLevel the level of verbosity
    321321 * @param classID the class that should be displayed (if CL_NULL (default) all classes will be displayed)
     
    365365
    366366/**
    367  * Print out some very nice debug information
     367 * @brief Print out some very nice debug information
    368368 * @param debugLevel the level of verbosity
    369369 * @param className the class that should be displayed.
Note: See TracChangeset for help on using the changeset viewer.