Changeset 4487 in orxonox.OLD for orxonox/trunk/src/util/loading/game_loader.cc

Timestamp:

Jun 3, 2005, 12:56:57 AM (19 years ago)

Author:

bensch

Message:

orxonox/trunk: more doxygen-tags in util

File:

• orxonox/trunk/src/util/loading/game_loader.cc (modified) (11 diffs)

orxonox/trunk/src/util/loading/game_loader.cc

@@ -37 +37 @@
 
 /**
-  \brief simple constructor
- */
+   \brief simple constructor
+*/
 GameLoader::GameLoader () 
 {
@@ -46 +46 @@
 
 /**
-  \brief simple deconstructor
- */
+   \brief simple deconstructor
+*/
 GameLoader::~GameLoader () {}
 
@@ -64 +64 @@
 }
 
-
+/**
+   \brief initializes the GameLoader
+*/
 ErrorMessage GameLoader::init()
 {
@@ -80 +82 @@
 /**
    \brief reads a campaign definition file into a campaign class
-   \param filename to be loaded
+   \param fileName to be loaded
    \returns the loaded campaign
 
    this will interprete the map/campaign files and recursivly load a tree of worlds/campaigns
 */
-ErrorMessage GameLoader::loadCampaign(const char* name)
+ErrorMessage GameLoader::loadCampaign(const char* fileName)
 {
   ErrorMessage errorCode;
-  char* campaignName = ResourceManager::getFullName(name);
+  char* campaignName = ResourceManager::getFullName(fileName);
   if (campaignName)
     {
@@ -101 +103 @@
 /**
    \brief loads a debug campaign for test purposes only.
-   \param the identifier of the campaign.
+   \param campaignID the identifier of the campaign.
    \returns error message if not able to do so.
 */
@@ -198 +200 @@
  */
 ErrorMessage GameLoader::destroy()
-{}
+{
+
+}
 
 
 /**
    \brief reads a campaign definition file into a campaign class
-   \param filename to be loaded
+   \param fileName to be loaded
    \returns the loaded campaign
 
    this will interprete the map/campaign files and recursivly load a tree of worlds/campaigns
 */
-Campaign* GameLoader::fileToCampaign(const char *name)
+Campaign* GameLoader::fileToCampaign(const char* fileName)
 {
   /* do not entirely load the campaign. just the current world
@@ -215 +219 @@
   */
   
-  if( name == NULL)
+  if( fileName == NULL)
     {
       PRINTF(2)("No filename specified for loading");
@@ -221 +225 @@
     }
   
-  TiXmlDocument* XMLDoc = new TiXmlDocument( name);
+  TiXmlDocument* XMLDoc = new TiXmlDocument( fileName);
   // load the campaign document
   if( !XMLDoc->LoadFile())
     {
       // report an error
-      PRINTF(1)("Could not load XML File %s: %s @ %d:%d\n", name, XMLDoc->ErrorDesc(), XMLDoc->ErrorRow(), XMLDoc->ErrorCol());
+      PRINTF(1)("Could not load XML File %s: %s @ %d:%d\n", fileName, XMLDoc->ErrorDesc(), XMLDoc->ErrorRow(), XMLDoc->ErrorCol());
       delete XMLDoc;
       return NULL;
@@ -255 +259 @@
 /**
    \brief handle keyboard commands 
-   \param the event to handle
+   \param event the event to handle
 */
 void GameLoader::process(const Event& event)
@@ -290 +294 @@
 
 
-/*
+/**
   \brief this changes to the next level
 */
@@ -300 +304 @@
 
 
-/*
+/**
   \brief change to the previous level - not implemented