Changeset 4836 in orxonox.OLD for orxonox/trunk/src/util/loading
- Timestamp:
- Jul 12, 2005, 12:33:16 AM (19 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
- Location:
- orxonox/trunk/src/util/loading
- Files:
-
- 6 edited
-
factory.cc (modified) (3 diffs)
-
factory.h (modified) (4 diffs)
-
game_loader.cc (modified) (14 diffs)
-
game_loader.h (modified) (2 diffs)
-
load_param.cc (modified) (12 diffs)
-
load_param.h (modified) (8 diffs)
Legend:
- Unmodified
- Added
- Removed
-
orxonox/trunk/src/util/loading/factory.cc
r4739 r4836 26 26 27 27 /** 28 \briefconstructor28 * constructor 29 29 30 30 set everything to zero and define factoryName … … 44 44 45 45 /** 46 \briefdestructor46 * destructor 47 47 48 48 clear the Q … … 58 58 59 59 /** 60 \briefadd a Factory to the Factory Queue61 \param factory a Factory to be registered60 * add a Factory to the Factory Queue 61 * @param factory a Factory to be registered 62 62 */ 63 63 void Factory::registerFactory( Factory* factory) -
orxonox/trunk/src/util/loading/factory.h
r4746 r4836 33 33 Creates a factory to a Loadable Class. 34 34 this should be used at the beginning of all the Classes that should be loadable (in the cc-file) 35 \todo make factoryName a BaseObject-parameter. (else it would be redundant)35 @todo make factoryName a BaseObject-parameter. (else it would be redundant) 36 36 */ 37 37 #define CREATE_FACTORY(CLASS_NAME) tFactory<CLASS_NAME>* global_##CLASS_NAME##_Factory = new tFactory<CLASS_NAME>(#CLASS_NAME) … … 48 48 49 49 static void registerFactory( Factory* factory); 50 /** \brief sets the Next factory in the list \param nextFactory the next factory */50 /** \brief sets the Next factory in the list @param nextFactory the next factory */ 51 51 inline void setNext( Factory* nextFactory) { this->next = nextFactory; }; 52 /** \returns the first factory */52 /** @returns the first factory */ 53 53 static Factory* getFirst() { return Factory::first; }; 54 /** \returns the next factory */54 /** @returns the next factory */ 55 55 Factory* getNext() const { return this->next; }; 56 56 … … 64 64 65 65 /** 66 \briefa factory that is able to load any kind of Object66 * a factory that is able to load any kind of Object 67 67 (this is a Functor) 68 68 */ … … 78 78 79 79 /** 80 \briefconstrunts a factory with81 \param factoryName the name of the factory80 * construnts a factory with 81 * @param factoryName the name of the factory 82 82 */ 83 83 template<class T> -
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) -
orxonox/trunk/src/util/loading/game_loader.h
r4739 r4836 1 1 /*! 2 2 \file game_loader.h 3 \briefloads campaigns, worlds and all other story_entities3 * loads campaigns, worlds and all other story_entities 4 4 */ 5 5 … … 57 57 void previousLevel(); 58 58 59 /** \brief a world command to send to the GameLoader \param cmd the command */59 /** \brief a world command to send to the GameLoader @param cmd the command */ 60 60 bool worldCommand(Command* cmd); 61 61 ErrorMessage loadDebugCampaign(Uint32 campaignID); -
orxonox/trunk/src/util/loading/load_param.cc
r4746 r4836 22 22 23 23 /** 24 \param object The object this Parameter is loaded too.25 \param root: the XML-element to load this option from.26 \param paramName: The name of the parameter loaded.27 \param paramCount: how many parameters this loading-function takes28 \param multi: if false LoadParam assumes only one occurence of this parameter in root, if true it assumes multiple occurences.29 \param ...: the parameter information (1. Parameter, 2. Default Value for the Parameter, ...)24 * @param object The object this Parameter is loaded too. 25 * @param root: the XML-element to load this option from. 26 * @param paramName: The name of the parameter loaded. 27 * @param paramCount: how many parameters this loading-function takes 28 * @param multi: if false LoadParam assumes only one occurence of this parameter in root, if true it assumes multiple occurences. 29 * @param ...: the parameter information (1. Parameter, 2. Default Value for the Parameter, ...) 30 30 */ 31 31 BaseLoadParam::BaseLoadParam(const TiXmlElement* root, BaseObject* object, const char* paramName, … … 152 152 153 153 /** 154 \param descriptionText The text to set as a description for this Parameter155 \returns a pointer to itself.154 * @param descriptionText The text to set as a description for this Parameter 155 * @returns a pointer to itself. 156 156 */ 157 157 BaseLoadParam* BaseLoadParam::describe(const char* descriptionText) … … 165 165 166 166 /** 167 \param paramName the name of the parameter to load167 * @param paramName the name of the parameter to load 168 168 */ 169 169 LoadParamDescription::LoadParamDescription(const char* paramName) … … 177 177 178 178 /** 179 \briefremoves all the alocated memory179 * removes all the alocated memory 180 180 */ 181 181 LoadParamDescription::~LoadParamDescription() … … 197 197 198 198 /** 199 \param descriptionText The text to set as a description for this Parameter199 * @param descriptionText The text to set as a description for this Parameter 200 200 */ 201 201 void LoadParamDescription::setDescription(const char* descriptionText) … … 206 206 207 207 /** 208 \briefprints out this parameter, its input method and the description (if availiable)208 * prints out this parameter, its input method and the description (if availiable) 209 209 */ 210 210 void LoadParamDescription::print() const … … 243 243 244 244 /** 245 \briefA list, that holds all the classes that are loadable (classes not objects!!)245 * A list, that holds all the classes that are loadable (classes not objects!!) 246 246 */ 247 247 tList<LoadClassDescription>* LoadClassDescription::classList = new tList<LoadClassDescription>; 248 248 249 249 /** 250 \briefif the description of Parameters should be executed250 * if the description of Parameters should be executed 251 251 */ 252 252 bool LoadClassDescription::parametersDescription = true; 253 253 254 254 /** 255 \param className the name of the class to be loadable255 * @param className the name of the class to be loadable 256 256 */ 257 257 LoadClassDescription::LoadClassDescription(const char* className) … … 266 266 267 267 /** 268 \briefdeletes a classDescription (deletes all the parameterDescriptions as well268 * deletes a classDescription (deletes all the parameterDescriptions as well 269 269 */ 270 270 LoadClassDescription::~LoadClassDescription() … … 283 283 284 284 /** 285 \briefadds a class to the list of loadable classes286 \param className The name of the class to add285 * adds a class to the list of loadable classes 286 * @param className The name of the class to add 287 287 288 288 this function searches for the className string, and if found just returns the appropriate Class. … … 308 308 309 309 /** 310 \briefdoes the same as addClass(const char* className), but with params311 \param paramName the name of the parameter to add.310 * does the same as addClass(const char* className), but with params 311 * @param paramName the name of the parameter to add. 312 312 */ 313 313 LoadParamDescription* LoadClassDescription::addParam(const char* paramName) … … 331 331 332 332 /** 333 \briefprints out all loadable Classes, and their parameters333 * prints out all loadable Classes, and their parameters 334 334 */ 335 335 void LoadClassDescription::printAll(const char* fileName) … … 361 361 362 362 /** 363 \param root: The XML-element to grab a parameter from364 \param parameterName: the parameter to grab365 \returns the Value of the parameter if found, NULL otherwise363 * @param root: The XML-element to grab a parameter from 364 * @param parameterName: the parameter to grab 365 * @returns the Value of the parameter if found, NULL otherwise 366 366 */ 367 367 const char* grabParameter(const TiXmlElement* root, const char* parameterName) -
orxonox/trunk/src/util/loading/load_param.h
r4834 r4836 16 16 /*! 17 17 \file load_param.h 18 \briefA Class and macro-functions, that makes our lives easy to load-in parameters18 * A Class and macro-functions, that makes our lives easy to load-in parameters 19 19 */ 20 20 … … 111 111 // 1. TYPE 112 112 /** 113 \briefa Macro to easily implement many different Constructors for the LoadParam-Class with 1 argument114 \param type1 The type of the first functionParameter113 * a Macro to easily implement many different Constructors for the LoadParam-Class with 1 argument 114 * @param type1 The type of the first functionParameter 115 115 */ 116 116 #define LoadParam1(type1) \ … … 128 128 // 2. TYPES 129 129 /** 130 \briefa Macro to easily implement many different Constructors for the LoadParam-Class with 2 arguments131 \param type1 The type of the first functionParameter132 \param type2 The type of the second functionParameter130 * a Macro to easily implement many different Constructors for the LoadParam-Class with 2 arguments 131 * @param type1 The type of the first functionParameter 132 * @param type2 The type of the second functionParameter 133 133 */ 134 134 #define LoadParam2(type1, type2) \ … … 153 153 // 3. TYPES 154 154 /** 155 \briefa Macro to easily implement many different Constructors for the LoadParam-Class with 3 arguments156 \param type1 The type of the first functionParameter157 \param type2 The type of the second functionParameter158 \param type3 The type of the third functionParameter155 * a Macro to easily implement many different Constructors for the LoadParam-Class with 3 arguments 156 * @param type1 The type of the first functionParameter 157 * @param type2 The type of the second functionParameter 158 * @param type3 The type of the third functionParameter 159 159 */ 160 160 #define LoadParam3(type1, type2, type3) \ … … 179 179 // 4. TYPES 180 180 /** 181 \briefa Macro to easily implement many different Constructors for the LoadParam-Class with 4 arguments182 \param type1 The type of the first functionParameter183 \param type2 The type of the second functionParameter184 \param type3 The type of the third functionParameter185 \param type4 The type of the forth functionParameter181 * a Macro to easily implement many different Constructors for the LoadParam-Class with 4 arguments 182 * @param type1 The type of the first functionParameter 183 * @param type2 The type of the second functionParameter 184 * @param type3 The type of the third functionParameter 185 * @param type4 The type of the forth functionParameter 186 186 */ 187 187 #define LoadParam4(type1, type2, type3, type4) \ … … 208 208 // 5. TYPES 209 209 /** 210 \briefa Macro to easily implement many different Constructors for the LoadParam-Class with 5 arguments211 \param type1 The type of the first functionParameter212 \param type2 The type of the second functionParameter213 \param type3 The type of the third functionParameter214 \param type4 The type of the forth functionParameter215 \param type5 The type of the fifth functionParameter210 * a Macro to easily implement many different Constructors for the LoadParam-Class with 5 arguments 211 * @param type1 The type of the first functionParameter 212 * @param type2 The type of the second functionParameter 213 * @param type3 The type of the third functionParameter 214 * @param type4 The type of the forth functionParameter 215 * @param type5 The type of the fifth functionParameter 216 216 */ 217 217 #define LoadParam5(type1, type2, type3, type4, type5) \ … … 238 238 // Pointer TYPE 239 239 /** 240 \briefa Macro to easily implement many different Constructors for the LoadParam-Class with one Pointer argument241 \param type1 The type of the Pointer240 * a Macro to easily implement many different Constructors for the LoadParam-Class with one Pointer argument 241 * @param type1 The type of the Pointer 242 242 */ 243 243 #define LoadParamPT(type1) \ … … 276 276 277 277 void setDescription(const char* descriptionText); 278 /** \returns the descriptionString */278 /** @returns the descriptionString */ 279 279 const char* getDescription() { return this->description; }; 280 280
Note: See TracChangeset
for help on using the changeset viewer.
