Changeset 2159 for code/branches/questsystem2/src/orxonox/objects/quest/Rewardable.h

Timestamp:

Nov 8, 2008, 7:58:49 PM (17 years ago)

Author:

dafrick

Message:

Completed documentation of finished classes.

File:

• code/branches/questsystem2/src/orxonox/objects/quest/Rewardable.h (modified) (3 diffs)

code/branches/questsystem2/src/orxonox/objects/quest/Rewardable.h

@@ -27 +27 @@
  */
 
+/**
+    @file Rewardable.h
+    @brief
+        Definition of the Rewardable class.
+*/
+
 #ifndef _Rewardable_H__
 #define _Rewardable_H__
@@ -38 +44 @@
     /**
     @brief
-        Rewardable is an Interface, that can be implemented by any object to enable it to be given as reward to a player through QuestEffects.
+        Rewardable is an Interface, that can be implemented by any object to enable it to be given as reward to a player through QuestEffects. (With the AddReward effect.)
+        
+        It just needs to inherit form Rewardable, and implement the reward() method.
     @author
         Damian 'Mozork' Frick
@@ -49 +57 @@
             virtual ~Rewardable();
 
-            virtual bool reward(ControllableEntity* player) = 0; //!<Method to transcribe a rewardable object to the player.
+            /**
+            @brief
+                Method to transcribe a rewardable object to the player.
+                Must be implemented by every class inheriting from Rewardable.
+            @param player
+                A pointer to the ControllableEntity, do whatever you want with it.
+            @return
+                Return true if successful.
+            */
+            virtual bool reward(ControllableEntity* player) = 0; //!<
 
     };