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

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

@@ -27 +27 @@
  */
 
+/**
+    @file QuestDescription.h
+    @brief
+        Definition of the QuestDescription class.
+*/
+
 #ifndef _QuestDescription_H__
 #define _QuestDescription_H__
@@ -52 +58 @@
             virtual ~QuestDescription();
 
-            virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode);
+            virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode); //!< Method for creating a QuestDescription object through XML.
 
             inline const std::string & getTitle(void) const //!< Returns the title.
@@ -60 +66 @@
 
         private:
-            void initialize(void);
+            std::string title_; //!< The title.
+            std::string description_; //!< The description.
 
             inline void setTitle(const std::string & title) //!< Sets the title.
@@ -67 +74 @@
                 { this->description_ = description; }
 
-            std::string title_; //!< The title.
-            std::string description_; //!< The description.
-
     };