Changeset 4836 in orxonox.OLD for orxonox/trunk/src/util/loading/game_loader.cc
- Timestamp:
- Jul 12, 2005, 12:33:16 AM (20 years ago)
-
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
-
orxonox/trunk/src/util/loading/game_loader.cc (modified) (14 diffs)
Legend:
- Unmodified
- Added
- Removed
-
orxonox/trunk/src/util/loading/game_loader.cc
r4817 r4836 37 37 38 38 /** 39 \briefsimple constructor39 * simple constructor 40 40 */ 41 41 GameLoader::GameLoader () … … 47 47 48 48 /** 49 \briefsimple deconstructor49 * simple deconstructor 50 50 */ 51 51 GameLoader::~GameLoader () … … 59 59 60 60 /** 61 \briefthis class is a singleton class62 \returns an instance of itself61 * this class is a singleton class 62 * @returns an instance of itself 63 63 64 64 if you are unsure about singleton classes, check the theory out on the internet :) … … 72 72 73 73 /** 74 \briefinitializes the GameLoader74 * initializes the GameLoader 75 75 */ 76 76 ErrorMessage GameLoader::init() … … 88 88 89 89 /** 90 \briefreads a campaign definition file into a campaign class91 \param fileName to be loaded92 \returns the loaded campaign90 * reads a campaign definition file into a campaign class 91 * @param fileName to be loaded 92 * @returns the loaded campaign 93 93 94 94 this will interprete the map/campaign files and recursivly load a tree of worlds/campaigns … … 109 109 110 110 /** 111 \briefloads a debug campaign for test purposes only.112 \param campaignID the identifier of the campaign.113 \returns error message if not able to do so.111 * loads a debug campaign for test purposes only. 112 * @param campaignID the identifier of the campaign. 113 * @returns error message if not able to do so. 114 114 */ 115 115 ErrorMessage GameLoader::loadDebugCampaign(Uint32 campaignID) … … 147 147 148 148 /** 149 \briefstarts the current entity150 \returns error code if this action has caused a error149 * starts the current entity 150 * @returns error code if this action has caused a error 151 151 */ 152 152 ErrorMessage GameLoader::start() … … 158 158 159 159 /** 160 \briefstops the current entity161 \returns error code if this action has caused a error160 * stops the current entity 161 * @returns error code if this action has caused a error 162 162 163 163 ATTENTION: this function shouldn't call other functions, or if so, they must return … … 175 175 176 176 /** 177 \briefpause the current entity178 \returns error code if this action has caused a error177 * pause the current entity 178 * @returns error code if this action has caused a error 179 179 180 180 this pauses the current entity or passes this call forth to the running entity. … … 189 189 190 190 /** 191 \briefresumes a pause192 \returns error code if this action has caused a error191 * resumes a pause 192 * @returns error code if this action has caused a error 193 193 194 194 this resumess the current entity or passes this call forth to the running entity. … … 203 203 204 204 /** 205 \briefrelease the mem ATTENTION: not implemented205 * release the mem ATTENTION: not implemented 206 206 */ 207 207 ErrorMessage GameLoader::destroy() … … 212 212 213 213 /** 214 \briefreads a campaign definition file into a campaign class215 \param fileName to be loaded216 \returns the loaded campaign214 * reads a campaign definition file into a campaign class 215 * @param fileName to be loaded 216 * @returns the loaded campaign 217 217 218 218 this will interprete the map/campaign files and recursivly load a tree of worlds/campaigns … … 264 264 265 265 /** 266 \briefhandle keyboard commands267 \param event the event to handle266 * handle keyboard commands 267 * @param event the event to handle 268 268 */ 269 269 void GameLoader::process(const Event& event) … … 322 322 323 323 /** 324 \briefload a StoryEntity325 \param element a XMLElement containing all the needed info324 * load a StoryEntity 325 * @param element a XMLElement containing all the needed info 326 326 */ 327 327 BaseObject* GameLoader::fabricate(const TiXmlElement* element)
Note: See TracChangeset
for help on using the changeset viewer.
