Changeset 2159 for code/branches/questsystem2/src/orxonox/objects/quest/AddReward.cc

Timestamp:

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

Author:

dafrick

Message:

Completed documentation of finished classes.

File:

• code/branches/questsystem2/src/orxonox/objects/quest/AddReward.cc (modified) (4 diffs)

code/branches/questsystem2/src/orxonox/objects/quest/AddReward.cc

@@ -27 +27 @@
  */
 
+/**
+    @file AddReward.cc
+    @brief
+        Implementation of the AddReward class.
+*/
+
 #include "OrxonoxStableHeaders.h"
 #include "AddReward.h"
@@ -39 +45 @@
     CreateFactory(AddReward);
 
+    /**
+    @brief
+        Constructor. Registers the object.
+    */
     AddReward::AddReward(BaseObject* creator) : QuestEffect(creator)
     {
         RegisterObject(AddReward);
-
-        this->initialize();
     }
 
@@ -54 +62 @@
     }
 
+    /**
+        Method for creating a AddReward object through XML.
+    */
     void AddReward::XMLPort(Element& xmlelement, XMLPort::Mode mode)
     {
@@ -64 +75 @@
     /**
     @brief
-        Initializes the object. Needs to be called first by every constructor of this class.
+        Returns the rewardbale object at the given index.
+    @param index
+        The index.
+    @return
+        Returns a pointer to the rewardable object at the given index.
     */
-    void AddReward::initialize(void)
-    {
-        RegisterObject(AddReward);
-    }
-
     const Rewardable* AddReward::getRewardables(unsigned int index) const
     {