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

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

@@ -27 +27 @@
  */
 
+/**
+    @file AddQuest.cc
+    @brief
+        Implementation of the AddQuest class.
+*/
+
 #include "OrxonoxStableHeaders.h"
 #include "AddQuest.h"
@@ -43 +49 @@
     CreateFactory(AddQuest);
 
-
+    /**
+    @brief
+        Constructor. Registers the quest.
+    */
     AddQuest::AddQuest(BaseObject* creator) : ChangeQuestStatus(creator)
     {
@@ -57 +66 @@
     }
 
+    /**
+    @brief
+        Method for creating a AddQuest object through XML.
+    */
     void AddQuest::XMLPort(Element& xmlelement, XMLPort::Mode mode)
     {
@@ -73 +86 @@
     bool AddQuest::invoke(ControllableEntity* player)
     {
-        if(player == NULL)
+        if(player == NULL) //!< Null-pointers are badass.
         {
             COUT(2) << "Input player is NULL." << std::endl;