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

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

@@ -28 +28 @@
 
 /**
-    @file
+    @file QuestItem.h
     @brief Definition of the QuestItem class.
-        The QuestItem is the parent class of Quest and QuestHint.
+        The @ref orxonox::QuestItem "QuestItem" is the parent class of @ref orxonox::Quest "Quest" and @ref orxonox::QuestHint "QuestHint".
+    @ingroup Questsystem
 */
 
@@ -47 +48 @@
     /**
     @brief
-        Functions as a base class for quest classes such as Quest or QuestHint.
-        Has a unique identifier and a description.
+        Functions as a base class for quest classes such as @ref orxonox::Quest "Quest" or @ref orxonox::QuestHint "QuestHint".
+        Has a unique identifier and a @ref orxonox::QuestDescription "QuestDescription".
     @author
         Damian 'Mozork' Frick