Changeset 2159 for code/branches/questsystem2/src/orxonox/objects/quest/AddQuestHint.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/AddQuestHint.cc (modified) (6 diffs)

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

@@ -27 +27 @@
  */
 
+/**
+    @file AddQuestHint.cc
+    @brief
+        Implementation of the AddQuestHint class.
+*/
+
 #include "OrxonoxStableHeaders.h"
 #include "AddQuestHint.h"
@@ -42 +48 @@
     CreateFactory(AddQuestHint);
 
+    /**
+    @brief
+        Constructor. Registers the object.
+    */
     AddQuestHint::AddQuestHint(BaseObject* creator) : QuestEffect(creator)
     {
@@ -55 +65 @@
     }
 
+    /**
+    @brief
+        Method for creating a AddQuestHint object through XML.
+    */
     void AddQuestHint::XMLPort(Element& xmlelement, XMLPort::Mode mode)
     {
@@ -63 +77 @@
     }
 
+    /**
+    @brief
+        Sets the id of the quest hint to be added to the player the effect is invoked on.
+    @param id
+        The QuestHint id.
+    @param
+        Returns true if successful.
+    */
     inline void AddQuestHint::setHintId(const std::string & id)
     {
@@ -68 +90 @@
         {
             COUT(2) << "Invalid id. QuestItem id {" << id << "} could not be set." << std::endl;
-            return;
+            return false;
         }
+        
         this->hintId_ = id;
+        return true;
     }
 
@@ -83 +107 @@
     bool AddQuestHint::invoke(ControllableEntity* player)
     {
-        if(player == NULL)
+        if(player == NULL) //!< NULL-pointers are evil!
         {
             COUT(2) << "The input player is NULL." << std::endl;