Changeset 7456 for code/trunk/src/modules/questsystem/QuestDescription.h

Timestamp:

Sep 15, 2010, 7:29:16 PM (14 years ago)

Author:

dafrick

Message:

Reviewing documentation fo Questsystem, moving documentation fully into doxygen.
Added some files to modules they belong to.

File:

• code/trunk/src/modules/questsystem/QuestDescription.h (modified) (2 diffs)

code/trunk/src/modules/questsystem/QuestDescription.h

@@ -28 +28 @@
 
 /**
-    @file
+    @file QuestDescription.h
     @brief Definition of the QuestDescription class.
+    @ingroup Questsystem
 */
 
@@ -45 +46 @@
     /**
     @brief
-        This class is a description of a QuestItem.
-        It holds a title and a description.
+        This class is a description of a QuestItem (@ref orxonox::Quest "Quest" and @ref orxonox::QuestHint "QuestHint").
+        It holds a title and a description. For quests also messages that are sent, when failing or completing the quest can be added.
 
         Creating a QuestDescription through XML goes as follows:
-
         @code
         <QuestDescription title="Title" description="Description Text" failMessage="You fail." completeMessage="You win!" />