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

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

@@ -27 +27 @@
  */
 
+/**
+    @file AddQuestHint.h
+    @brief
+        Definition of the AddQuestHint class.
+*/
+
 #ifndef _AddQuestHint_H__
 #define _AddQuestHint_H__
@@ -40 +46 @@
     /**
     @brief
-        Adds a QuestHint, resp. Activates the QuestHint.
+        Adds a QuestHint, resp. activates the QuestHint of the given id for the player the effect is invoked on.
     @author
         Damian 'Mozork' Frick
@@ -50 +56 @@
             virtual ~AddQuestHint();
 
-            virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode);
+            virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode); //!< Method for creating a AddQuestHint object through XML.
 
             virtual bool invoke(ControllableEntity* player); //!< Invokes the effect.
 
         private:
-            std::string hintId_;
+            std::string hintId_; //!< The id of the QuestHint.
 
-            inline const std::string & getHintId(void) const
+            inline const std::string & getHintId(void) const //!< Returns the if of the hint.
                 { return this->hintId_; }
-            void setHintId(const std::string & id);
+            void setHintId(const std::string & id); //!< Sets the id of the hint.
 
     };