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

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

@@ -27 +27 @@
  */
 
+/**
+    @file CompleteQuest.h
+    @brief
+        Definition of the CompleteQuest class.
+*/
+
 #ifndef _CompleteQuest_H__
 #define _CompleteQuest_H__
@@ -41 +47 @@
     /**
     @brief
-        Completes a quest.
+        Completes a quest (with a specified id) for the player invoking the effect.
     @author
         Damian 'Mozork' Frick
@@ -51 +57 @@
             virtual ~CompleteQuest();
 
-            virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode);
+            virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode); //!< Method for creating a CompleteQuest object through XML.
 
             virtual bool invoke(ControllableEntity* player); //!< Invokes the effect.