Changeset 7456 for code/trunk/src/modules/questsystem/QuestHint.cc

Timestamp:

Sep 15, 2010, 7:29:16 PM (14 years ago)

Author:

dafrick

Message:

Reviewing documentation fo Questsystem, moving documentation fully into doxygen.
Added some files to modules they belong to.

File:

• code/trunk/src/modules/questsystem/QuestHint.cc (modified) (7 diffs)

code/trunk/src/modules/questsystem/QuestHint.cc

@@ -28 +28 @@
 
 /**
-    @file
+    @file QuestHint.cc
     @brief Implementation of the QuestHint class.
 */
@@ -36 +36 @@
 #include "core/CoreIncludes.h"
 #include "core/XMLPort.h"
+
+#include "Quest.h"
+#include "QuestDescription.h"
 #include "QuestManager.h"
-#include "QuestDescription.h"
-#include "Quest.h"
 
 namespace orxonox
@@ -71 +72 @@
         SUPER(QuestHint, XMLPort, xmlelement, mode);
 
-        QuestManager::getInstance().registerHint(this); //!< Registers the QuestHint with the QuestManager.
+        QuestManager::getInstance().registerHint(this); // Registers the QuestHint with the QuestManager.
 
         COUT(4) << "New QuestHint {" << this->getId() << "} created." << std::endl;
@@ -89 +90 @@
     bool QuestHint::isActive(const PlayerInfo* player) const
     {
-        if(player == NULL) //!< NULL-Pointers are ugly!
+        //TODO: Replace with asser.
+        if(player == NULL) // NULL-Pointers are ugly!
         {
             ThrowException(Argument, "The input PlayerInfo* is NULL.");
@@ -95 +97 @@
         }
 
-        //! Find the player.
+        // Find the player.
         std::map<const PlayerInfo*, QuestHintStatus::Value>::const_iterator it = this->playerStatus_.find(player);
-        if (it != this->playerStatus_.end()) //!< If the player is in the map.
-        {
+        if (it != this->playerStatus_.end()) // If the player is in the map.
             return it->second;
-        }
 
         return QuestStatus::Inactive;
@@ -115 +115 @@
     bool QuestHint::setActive(PlayerInfo* player)
     {
-        if(this->quest_->isActive(player)) //!< For a hint to get activated the quest must be active.
+        if(this->quest_->isActive(player)) // For a hint to get activated the quest must be active.
         {
-            if(!(this->isActive(player)))  //!< If the hint is already active, activation is pointless.
+            if(!(this->isActive(player)))  // If the hint is already active, activation is pointless.
             {
                 this->playerStatus_[player] = QuestHintStatus::Active;
@@ -145 +145 @@
     bool QuestHint::setQuest(Quest* quest)
     {
-        if(quest == NULL) //!< NULL-Pointer. Again..?
+        //TODO: Replace with assert.
+        if(quest == NULL) // NULL-Pointer. Again..?
         {
             COUT(2) << "The input Quest* is NULL." << std::endl;