Changeset 2159 for code/branches/questsystem2/src/orxonox/objects/quest/AddQuest.h

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/AddQuest.h (modified) (3 diffs)

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

@@ -27 +27 @@
  */
 
+/**
+    @file AddQuest.h
+    @brief
+        Definition of the AddQuest class.
+*/
+
 #ifndef _AddQuest_H__
 #define _AddQuest_H__
@@ -41 +47 @@
     /**
     @brief
-        Adds a quest, resp. changes the quests status to active.
+        Adds a quest, resp. changes the quests status to active for the player invoking the quest.
     @author
         Damian 'Mozork' Frick
@@ -51 +57 @@
             virtual ~AddQuest();
 
-            virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode);
+            virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode); //!< Method for creating a AddQuest object through XML.
 
             virtual bool invoke(ControllableEntity* player); //!< Invokes the effect.