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

Timestamp:

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

Author:

dafrick

Message:

Completed documentation of finished classes.

File:

• code/branches/questsystem2/src/orxonox/objects/quest/FailQuest.cc (modified) (4 diffs)

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

@@ -26 +26 @@
  *
  */
+ 
+/**
+    @file FailQuest.cc
+    @brief
+        Implementation of the FailQuest class.
+*/
 
 #include "OrxonoxStableHeaders.h"
@@ -41 +47 @@
     CreateFactory(FailQuest);
 
+    /**
+    @brief
+        Constructor. Registers the object.
+    */
     FailQuest::FailQuest(BaseObject* creator) : ChangeQuestStatus(creator)
     {
@@ -54 +64 @@
     }
 
+    /**
+    @brief
+        Method for creating a FailQuest object through XML.
+    */
     void FailQuest::XMLPort(Element& xmlelement, XMLPort::Mode mode)
     {
@@ -69 +83 @@
     bool FailQuest::invoke(ControllableEntity* player)
     {
-        if(player == NULL)
+        if(player == NULL) //!< We don't know what to do with no player.
         {
             COUT(2) << "Input player is NULL." << std::endl;