Changeset 7456 for code/trunk/src/modules/questsystem/QuestHint.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/QuestHint.h (modified) (3 diffs)

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

@@ -28 +28 @@
 
 /**
-    @file
+    @file QuestHint.h
     @brief Definition of the QuestHint class.
+    @ingroup Questsystem
 */
 
@@ -42 +43 @@
 namespace orxonox // tolua_export
 { // tolua_export
+
     namespace QuestHintStatus
     {
-        //! The state of the hint.
+        //! The state of the @ref orxonox::QuestHint "QuestHint".
         enum Value
         {
@@ -54 +56 @@
     /**
     @brief
-        Represents a hint in the game towards completing a Quest.
-        Consists of title and description (which is stored in a QuestDescription object) in textual form and must belong to a quest.
+        Represents a hint in the game that gives aid towards completing a @ref orxonox::Quest "Quest".
+        Consists of title and description (which is stored in a @ref orxonox::QuestDescription "QuestDescription" object) in textual form and must belong to a quest.
         A QuestHint has a defined status (inactive or active, where inactive is default) for each player, which means each a QuestHint exists only once for all players, it doesn't belong to a player, it just has different states for each of them.
 
         Creating a QuestHint through XML goes as follows:
-
         @code
         <QuestHint id="hintId">