Changeset 2159 for code/branches/questsystem2/src/orxonox/objects/quest/ChangeQuestStatus.cc

Timestamp:

Nov 8, 2008, 7:58:49 PM (15 years ago)

Author:

dafrick

Message:

Completed documentation of finished classes.

File:

• code/branches/questsystem2/src/orxonox/objects/quest/ChangeQuestStatus.cc (modified) (3 diffs)

code/branches/questsystem2/src/orxonox/objects/quest/ChangeQuestStatus.cc

@@ -27 +27 @@
  */
 
+/**
+    @file ChangeQuestStatus.cc
+    @brief
+        Implementation of the ChangeQuestStatus class.
+*/
+
 #include "OrxonoxStableHeaders.h"
 #include "ChangeQuestStatus.h"
@@ -36 +42 @@
 namespace orxonox {
 
+    /**
+    @brief
+        Constructor. Registers the object.
+    */
     ChangeQuestStatus::ChangeQuestStatus(BaseObject* creator) : QuestEffect(creator)
     {
@@ -49 +59 @@
     }
 
-    void ChangeQuestStatus::setQuestId(const std::string & id)
+    /**
+    @brief
+        Sets the id of the quest the effect chagnes the status of.
+    @param id
+        The id of the quest.
+    @return
+        Returns true if successful.
+    */
+    bool ChangeQuestStatus::setQuestId(const std::string & id)
     {
         if(!QuestItem::isId(id))
         {
             COUT(2) << "Invalid id. QuestItem id {" << id << "} could not be set." << std::endl;
-            return;
+            return false;
         }
+        
         this->questId_ = id;
+        return true;
     }
 
+    /**
+    @brief
+        Method for creating a ChangeQuestStatus object through XML.
+    */
     void ChangeQuestStatus::XMLPort(Element& xmlelement, XMLPort::Mode mode)
     {