Changeset 2146 for code/branches/questsystem2/src/orxonox/objects/quest/QuestItem.h

Timestamp:

Nov 6, 2008, 12:02:05 AM (16 years ago)

Author:

dafrick

Message:

Started implementation of QuestEffectBeacon.
Done some documentation of QuestItem and subclasses.

File:

• code/branches/questsystem2/src/orxonox/objects/quest/QuestItem.h (modified) (3 diffs)

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

@@ -26 +26 @@
  *
  */
+ 
+/**
+    @file QuestItem.h
+    @brief
+        Definition of the QuestItem class.
+        
+        The QuestItem is the parent class of Quest and QuestHint.
+*/
+
 
 #ifndef _QuestItem_H__
@@ -54 +63 @@
             virtual ~QuestItem();
 
-            virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode);
+            virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode); //!< Method for creating a QuestItem object through XML.
 
             inline const std::string & getId(void) const //!< Returns the id of this quest.
@@ -60 +69 @@
             inline const QuestDescription* getDescription(void) const //!< Returns the description of the QuestItem.
                 { return this->description_; }
-            //const QuestDescription* getDescription(unsigned int index) const; //!< Returns the description of the QuestItem.
 
             static bool isId(const std::string & id); //!< Checks whether a given id is valid.
 
         protected:
-            void setId(const std::string & id);
-            inline void setDescription(QuestDescription* description)
+            void setId(const std::string & id); //!< Sets the id of the QuestItem.
+            inline void setDescription(QuestDescription* description) //!< Sets the description of the QuestItem.
                 { this->description_ = description; }