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

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

@@ -28 +28 @@
 
 /**
-    @file
+    @file QuestEffect.h
     @brief Definition of the QuestEffect class.
+    @ingroup Questsystem
 */
 
@@ -44 +45 @@
     /**
     @brief
-        Handles QuestEffects for Quests.
-        QuestEffects are the only way for Quests to have any sideeffects in the game world. They are also the only way for a player to gain, complete or fail Quests.
+        Handles QuestEffects for @ref orxonox::Quest "Quests".
+        QuestEffects are one of the ways for @ref orxonox::Quest "Quests" to have any side effects on the game world and for the game world to influence the @ref orxonox::Quest "Quests".
     @author
         Damian 'Mozork' Frick
@@ -58 +59 @@
             static bool invokeEffects(PlayerInfo* player, std::list<QuestEffect*> & effects); //!< Invokes all QuestEffects in the list.
 
-
     };