[Orxonox-commit 3767] r8447 - in code/branches/tutoriallevel2: doc/api/groups src/libraries/network/synchronisable src/modules/objects/triggers src/modules/questsystem

[dafrick at orxonox.net]

Author: dafrick
Date: 2011-05-11 22:44:25 +0200 (Wed, 11 May 2011)
New Revision: 8447

Modified:
   code/branches/tutoriallevel2/doc/api/groups/Triggers.dox
   code/branches/tutoriallevel2/src/libraries/network/synchronisable/Synchronisable.cc
   code/branches/tutoriallevel2/src/modules/objects/triggers/DistanceTrigger.cc
   code/branches/tutoriallevel2/src/modules/objects/triggers/DistanceTrigger.h
   code/branches/tutoriallevel2/src/modules/objects/triggers/EventTrigger.h
   code/branches/tutoriallevel2/src/modules/questsystem/QuestManager.cc
Log:
Resolving some doxygen warnings.


Modified: code/branches/tutoriallevel2/doc/api/groups/Triggers.dox
===================================================================
--- code/branches/tutoriallevel2/doc/api/groups/Triggers.dox	2011-05-11 10:21:32 UTC (rev 8446)
+++ code/branches/tutoriallevel2/doc/api/groups/Triggers.dox	2011-05-11 20:44:25 UTC (rev 8447)
@@ -54,7 +54,7 @@
     - @b distance Which specifies the maximum distance at which the @ref orxonox::DistanceTrigger "DistanceTrigger" still triggers, i.e. its range. Default is <code>100</code>.
     - @b target Which specifies the class of objects that can trigger the @ref orxonox::DistanceTrigger "DistanceTrigger". Default is <code>"Pawn"</code>.
     - @b beaconMode Which specifies, whether the @ref orxonox::DistanceTrigger "DistanceTrigger" operates on @ref orxonox::DistanceTriggerBeacon "DistanceTriggerBeacons" or not. If <em>off</em> the DistanceMultiTrigger works as usual. If set to <em>identify</em> the @ref orxonox::DistanceTrigger "DistanceTrigger" is only triggered by objects that have a @ref orxonox::DistanceTriggerBeacon "DistanceTriggerBeacon", with the same name as specified in <em>targetname</em>, attached to them. If set to <em>exclude</em> the @ref orxonox::DistanceTrigger "DistanceTrigger" is only triggered by objects that don't have a @ref orxonox::DistanceTriggerBeacon "DistanceTriggerBeacon", with the same name as specified in <em>targetname</em>, attached to them. Default is <em>off</em>.
-    - @b targetname Which specifies the name @ref oroxnox::DistanceTriggerBeacon "DistanceTriggerBeacons" need to have to make the @ref orxonox::DistanceTrigger "DistanceTrigger" react to them if it is in <em>beacon-mode</em> (the beaconMode is not <em>off</em>).
+    - @b targetname Which specifies the name @ref orxonox::DistanceTriggerBeacon "DistanceTriggerBeacons" need to have to make the @ref orxonox::DistanceTrigger "DistanceTrigger" react to them if it is in <em>beacon-mode</em> (the beaconMode is not <em>off</em>).
 
     A simple @ref orxonox::DistanceTrigger "DistanceTrigger" could look like this:
     @code

Modified: code/branches/tutoriallevel2/src/libraries/network/synchronisable/Synchronisable.cc
===================================================================
--- code/branches/tutoriallevel2/src/libraries/network/synchronisable/Synchronisable.cc	2011-05-11 10:21:32 UTC (rev 8446)
+++ code/branches/tutoriallevel2/src/libraries/network/synchronisable/Synchronisable.cc	2011-05-11 20:44:25 UTC (rev 8447)
@@ -382,7 +382,6 @@
 
   /**
    * This function determines, wheter the object should be saved to the bytestream (according to its syncmode/direction)
-   * @param id gamestate id
    * @param mode Synchronisation mode (toclient, toserver or bidirectional)
    * @return true/false
    */
@@ -396,7 +395,6 @@
   
   /**
    * This function determines, wheter the object should accept data from the bytestream (according to its syncmode/direction)
-   * @param id gamestate id
    * @param mode Synchronisation mode (toclient, toserver or bidirectional)
    * @return true/false
    */

Modified: code/branches/tutoriallevel2/src/modules/objects/triggers/DistanceTrigger.cc
===================================================================
--- code/branches/tutoriallevel2/src/modules/objects/triggers/DistanceTrigger.cc	2011-05-11 10:21:32 UTC (rev 8446)
+++ code/branches/tutoriallevel2/src/modules/objects/triggers/DistanceTrigger.cc	2011-05-11 20:44:25 UTC (rev 8447)
@@ -279,7 +279,9 @@
     @brief
         Check whether the DistanceTrigger is triggered.
         It is triggered if it is triggered according only to its mode (i.e. its sub-triggers) and if a target is in range.
-    @param
+    @param mode
+        The mode for which it is tested, whether the DistanceTrigger is triggered.
+    @return
         Returns true if it is triggered ,false if not.
     */
     bool DistanceTrigger::isTriggered(TriggerMode::Value mode)

Modified: code/branches/tutoriallevel2/src/modules/objects/triggers/DistanceTrigger.h
===================================================================
--- code/branches/tutoriallevel2/src/modules/objects/triggers/DistanceTrigger.h	2011-05-11 10:21:32 UTC (rev 8446)
+++ code/branches/tutoriallevel2/src/modules/objects/triggers/DistanceTrigger.h	2011-05-11 20:44:25 UTC (rev 8447)
@@ -70,7 +70,7 @@
         - @b distance Which specifies the maximum distance at which the DistanceTrigger still triggers, i.e. its range. Default is <code>100</code>.
         - @b target Which specifies the class of objects that can trigger the DistanceTrigger. Default is <code>"Pawn"</code>.
         - @b beaconMode Which specifies, whether the DistanceTrigger operates on @ref orxonox::DistanceTriggerBeacon "DistanceTriggerBeacons" or not. If <em>off</em> the DistanceMultiTrigger works as usual. If set to <em>identify</em> the DistanceTrigger is only triggered by objects that have a @ref orxonox::DistanceTriggerBeacon "DistanceTriggerBeacon", with the same name as specified in <em>targetname</em>, attached to them. If set to <em>exclude</em> the DistanceTrigger is only triggered by objects that don't have a @ref orxonox::DistanceTriggerBeacon "DistanceTriggerBeacon", with the same name as specified in <em>targetname</em>, attached to them. Default is <em>off</em>.
-        - @b targetname Which specifies the name @ref oroxnox::DistanceTriggerBeacon "DistanceTriggerBeacons" need to have to make the DistanceTrigger react to them if it is in <em>beacon-mode</em> (the beaconMode is not <em>off</em>).
+        - @b targetname Which specifies the name @ref orxonox::DistanceTriggerBeacon "DistanceTriggerBeacons" need to have to make the DistanceTrigger react to them if it is in <em>beacon-mode</em> (the beaconMode is not <em>off</em>).
 
         A simple DistanceTrigger could look like this:
         @code

Modified: code/branches/tutoriallevel2/src/modules/objects/triggers/EventTrigger.h
===================================================================
--- code/branches/tutoriallevel2/src/modules/objects/triggers/EventTrigger.h	2011-05-11 10:21:32 UTC (rev 8446)
+++ code/branches/tutoriallevel2/src/modules/objects/triggers/EventTrigger.h	2011-05-11 20:44:25 UTC (rev 8447)
@@ -59,7 +59,7 @@
         @endcode
 
     @see Trigger
-        For more information on @ref oroxnox::Trigger "Triggers".
+        For more information on @ref orxonox::Trigger "Triggers".
 
     @author
         Fabian 'x3n' Landau

Modified: code/branches/tutoriallevel2/src/modules/questsystem/QuestManager.cc
===================================================================
--- code/branches/tutoriallevel2/src/modules/questsystem/QuestManager.cc	2011-05-11 10:21:32 UTC (rev 8446)
+++ code/branches/tutoriallevel2/src/modules/questsystem/QuestManager.cc	2011-05-11 20:44:25 UTC (rev 8447)
@@ -317,7 +317,8 @@
         The quest to get the hints of.
     @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)
     {
@@ -340,6 +341,8 @@
         The player.
     @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)
     {
@@ -354,11 +357,11 @@
 
     /**
     @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)
     {