Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

Ignore:
Timestamp:
Jul 12, 2005, 12:33:16 AM (20 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/story_entities/story_entity.cc

    r4597 r4836  
    3232
    3333/**
    34     \brief sets the story ID
     34  * sets the story ID
    3535
    3636    sets the story id of the current entity, this enables it to be identified in a
     
    4444
    4545/**
    46     \brief this reads the story id of the current entity
    47     \returns the story entity id
     46  * this reads the story id of the current entity
     47  * @returns the story entity id
    4848*/
    4949int StoryEntity::getStoryID()
     
    5454
    5555/**
    56     \brief sets the id of the next story entity
     56  * sets the id of the next story entity
    5757
    5858    StoryEntities can choose their following entity themselfs. the entity id defined here
     
    6666
    6767/**
    68     \brief gets the story id of the current entity
    69     \returns story id
     68  * gets the story id of the current entity
     69  * @returns story id
    7070*/
    7171int StoryEntity::getNextStoryID()
     
    7676
    7777/**
    78    \brief stuff that will have to be initialized before load
     78 * stuff that will have to be initialized before load
    7979
    8080   this gives all storyentities the possibility to init stuff before the
     
    8585
    8686/**
    87     \brief loads the current entity
     87  * loads the current entity
    8888
    8989    this is here to enable you loading maps into the entities. for all other actions you
     
    9696
    9797/**
    98     \brief initialize the entity before use.
    99     \returns an error code if not able to apply.
     98  * initialize the entity before use.
     99  * @returns an error code if not able to apply.
    100100
    101101    After execution of this function, the Entity is ready to be played/executed,
     
    108108
    109109/**
    110     \brief starts the entity with the choosen id. only for entities with lists.
    111     \param story id
    112     \returns error code if this action has caused a error
     110  * starts the entity with the choosen id. only for entities with lists.
     111  * @param story id
     112  * @returns error code if this action has caused a error
    113113
    114114    this simply starts the story with the id storyID. the story with the choosen id has
     
    122122
    123123/**
    124     \brief starts the current entity
    125     \returns error code if this action has caused a error
     124  * starts the current entity
     125  * @returns error code if this action has caused a error
    126126*/
    127127ErrorMessage StoryEntity::start()
     
    130130
    131131/**
    132     \brief pause the current entity
    133     \returns error code if this action has caused a error
     132  * pause the current entity
     133  * @returns error code if this action has caused a error
    134134
    135135    this pauses the current entity or passes this call forth to the running entity.
     
    140140
    141141/**
    142     \brief resumes a pause
    143     \returns error code if this action has caused a error
     142  * resumes a pause
     143  * @returns error code if this action has caused a error
    144144
    145145    this resumess the current entity or passes this call forth to the running entity.
     
    150150
    151151/**
    152     \brief stops the current entity
    153     \returns error code if this action has caused a error
     152  * stops the current entity
     153  * @returns error code if this action has caused a error
    154154
    155155    ATTENTION: this function shouldn't call other functions, or if so, they must return
     
    164164
    165165/**
    166     \brief destroys and cleans up the current entity.
     166  * destroys and cleans up the current entity.
    167167
    168168    this cleans up ressources before the deconstructor is called. for terminating
     
    174174
    175175/**
    176     \brief this displays the load screen
     176  * this displays the load screen
    177177
    178178    it will need some time to load maps or things like that. to inform the user about
     
    184184
    185185/**
    186     \brief undisplay the load screen
     186  * undisplay the load screen
    187187
    188188    the load process has terminated, you now can release the load screen and start this
Note: See TracChangeset for help on using the changeset viewer.