[Orxonox-commit 2594] r7299 - in code/branches/doc/src: libraries/core modules/pickup modules/questsystem

[dafrick at orxonox.net]

Author: dafrick
Date: 2010-08-31 23:04:10 +0200 (Tue, 31 Aug 2010)
New Revision: 7299

Modified:
   code/branches/doc/src/libraries/core/GUIManager.cc
   code/branches/doc/src/modules/pickup/DroppedPickup.cc
   code/branches/doc/src/modules/questsystem/QuestEffectBeacon.cc
   code/branches/doc/src/modules/questsystem/QuestEffectBeacon.h
Log:
Some fixes in doxygen documentation.


Modified: code/branches/doc/src/libraries/core/GUIManager.cc
===================================================================
--- code/branches/doc/src/libraries/core/GUIManager.cc	2010-08-31 18:56:01 UTC (rev 7298)
+++ code/branches/doc/src/libraries/core/GUIManager.cc	2010-08-31 21:04:10 UTC (rev 7299)
@@ -235,7 +235,7 @@
     @param name
         The name of the GUI
     @param bHidePrevious
-        FIXME - add doc!
+        If true all displayed GUIs on the stack, that are below this GUI are hidden.
 
         The function executes the Lua function with the same name in case the GUIManager is ready.
     */

Modified: code/branches/doc/src/modules/pickup/DroppedPickup.cc
===================================================================
--- code/branches/doc/src/modules/pickup/DroppedPickup.cc	2010-08-31 18:56:01 UTC (rev 7298)
+++ code/branches/doc/src/modules/pickup/DroppedPickup.cc	2010-08-31 21:04:10 UTC (rev 7299)
@@ -61,7 +61,7 @@
     @param pickup
         The Pickupable that was dropped.
     @param carrier
-        FIXME - add doc!
+        The PickupCarrier that carried the input pickup before it was dropped.
     @param triggerDistance
         The distance at which the PickupSpawner triggers. Default is 10.
     */

Modified: code/branches/doc/src/modules/questsystem/QuestEffectBeacon.cc
===================================================================
--- code/branches/doc/src/modules/questsystem/QuestEffectBeacon.cc	2010-08-31 18:56:01 UTC (rev 7298)
+++ code/branches/doc/src/modules/questsystem/QuestEffectBeacon.cc	2010-08-31 21:04:10 UTC (rev 7299)
@@ -91,16 +91,16 @@
     @brief
         Executes the QuestEffectBeacon.
         This means extracting the Pawn from the PlayerTrigger, provided by the Event causing the execution, and the extracting the PlayerInfo from the received Pawn and invoking the QuestEffectbeacon's QuestEffects on the received PlayerInfo.
-    @param b
+    @param bTriggered
         true means the trigger was activated while false means it was deactivated
     @param trigger
         A pointer to the PlayerTrigger that threw the Event.
     @return
         Returns true if successfully executed, false if not.
     */
-    bool QuestEffectBeacon::execute(bool b, BaseObject* trigger)
+    bool QuestEffectBeacon::execute(bool bTriggered, BaseObject* trigger)
     {
-        if(!b)
+        if(!bTriggered)
         {
             return false;
         }

Modified: code/branches/doc/src/modules/questsystem/QuestEffectBeacon.h
===================================================================
--- code/branches/doc/src/modules/questsystem/QuestEffectBeacon.h	2010-08-31 18:56:01 UTC (rev 7298)
+++ code/branches/doc/src/modules/questsystem/QuestEffectBeacon.h	2010-08-31 21:04:10 UTC (rev 7299)
@@ -89,7 +89,7 @@
             virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode); //!< Method for creating a QuestEffectBeacon object through XML.
             virtual void XMLEventPort(Element& xmlelement, XMLPort::Mode mode);
 
-            bool execute(bool b, BaseObject* trigger); //!< Executes the QuestEffects of the QuestEffectBeacon.
+            bool execute(bool bTriggered, BaseObject* trigger); //!< Executes the QuestEffects of the QuestEffectBeacon.
 
             /**
             @brief Tests whether the QuestEffectBeacon is active.