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

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

@@ -27 +27 @@
  */
 
+/**
+    @file ChangeQuestStatus.h
+    @brief
+        Definition of the ChangeQuestStatus class.
+*/
+
 #ifndef _ChangeQuestStatus_H__
 #define _ChangeQuestStatus_H__
@@ -41 +47 @@
     /**
     @brief
-        An effect which changes a quests status.
+        An effect which changes a quests status of a specified quest for the player invoking the effect.
     @author
         Damian 'Mozork' Frick
@@ -51 +57 @@
             virtual ~ChangeQuestStatus();
 
-            virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode);
+            virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode); //!< Method for creating a ChangeQuestStatus object through XML.
 
             virtual bool invoke(ControllableEntity* player) = 0; //!< Invokes the effect.
@@ -59 +65 @@
                 { return this->questId_; }
 
+        private:
             std::string questId_; //!< The id of the quest the status should be changed of.
-
-        private:
-            void setQuestId(const std::string & id);
+            
+            void setQuestId(const std::string & id); //!< Sets the quest id.
 
     };