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

code/trunk/src/modules/questsystem/effects/FailQuest.h

@@ -28 +28 @@
 
 /**
-    @file
+    @file FailQuest.h
     @brief Definition of the FailQuest class.
+    @ingroup QuestEffects
 */
 
@@ -42 +43 @@
     /**
     @brief
-        Fails a quest (with a specified id) for the player invoking the QuestEffect.
+        Fails a @ref orxonox::Quest "Quest" (with a specified id) for the player invoking the QuestEffect.
 
         Creating a FailQuest through XML goes as follows:
-
         @code
         <FailQuest questId="id" />  //Where id identifies the Quest that should be failed.