Changeset 8447 for code/branches/tutoriallevel2/src/modules/questsystem/QuestManager.cc

Timestamp:

May 11, 2011, 10:44:25 PM (13 years ago)

Author:

dafrick

Message:

Resolving some doxygen warnings.

File:

• code/branches/tutoriallevel2/src/modules/questsystem/QuestManager.cc (modified) (3 diffs)

code/branches/tutoriallevel2/src/modules/questsystem/QuestManager.cc

@@ -318 +318 @@
     @param player
         The player.
-    @return Returns the number of QuestHints of the input Quest for the input player.
+    @return
+        Returns the number of QuestHints of the input Quest for the input player.
     */
     int QuestManager::getNumHints(Quest* quest, PlayerInfo* player)
@@ -341 +342 @@
     @param index
         The index of the QuestHint.
+    @return
+        Returns a pointer to the index-th QuestHint of the input Quest for the input player.
     */
     QuestHint* QuestManager::getHints(Quest* quest, PlayerInfo* player, int index)
@@ -355 +358 @@
     /**
     @brief
-        Get the parent-quest of the input Quest for the input player.
+        Get the parent-quest of the input Quest.
     @param quest
         The Quest to get the parent-quest of.
-    @param player
-        The player.
+    @return
+        Returns a pointer to the parent-quest of the input Quest.
     */
     Quest* QuestManager::getParentQuest(Quest* quest)