Changeset 7552 for code/trunk/src/modules/questsystem/Quest.h

Timestamp:

Oct 17, 2010, 10:50:43 PM (14 years ago)

Author:

dafrick

Message:

Resolving some TODOs and doing some additional cleanup. Almost done now…

File:

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

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

@@ -44 +44 @@
 namespace orxonox // tolua_export
 { // tolua_export
+
+    /**
+    @brief
+        Different states of a @ref orxonox::Quest "Quest".
+
+    @ingroup Questsystem
+    */
     namespace QuestStatus
     {
-        //! Different states of a @ref orxonox::Quest "Quest".
         enum Value
         {
-            Inactive,
-            Active,
-            Failed,
-            Completed
+            Inactive, //!< The @ref orxonox::Quest "Quest" is inactive.
+            Active, //!< The @ref orxonox::Quest "Quest" is active.
+            Failed, //!< The @ref orxonox::Quest "Quest" has been failed.
+            Completed //!< The @ref orxonox::Quest "Quest" has been completed.
         };
     }
@@ -66 +72 @@
 
         Quest itself should not be instantiated, if you want to create a quest either use LocalQuest or GlobalQuest, whichever suits you needs better.
+
     @author
         Damian 'Mozork' Frick
+
+    @ingroup Questsystem
     */
     class _QuestsystemExport Quest // tolua_export