Changeset 7299

Timestamp:

Aug 31, 2010, 11:04:10 PM (14 years ago)

Author:

dafrick

Message:

Some fixes in doxygen documentation.

Location:

code/branches/doc/src

Files:

• libraries/core/GUIManager.cc (modified) (1 diff)
• modules/pickup/DroppedPickup.cc (modified) (1 diff)
• modules/questsystem/QuestEffectBeacon.cc (modified) (2 diffs)
• modules/questsystem/QuestEffectBeacon.h (modified) (1 diff)

code/branches/doc/src/libraries/core/GUIManager.cc

@@ -236 +236 @@
         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.

code/branches/doc/src/modules/pickup/DroppedPickup.cc

@@ -62 +62 @@
         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.

code/branches/doc/src/modules/questsystem/QuestEffectBeacon.cc

@@ -92 +92 @@
         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
@@ -99 +99 @@
         Returns true if successfully executed, false if not.
     */
-    bool QuestEffectBeacon::execute(bool b, BaseObject* trigger)
-    {
-        if(!b)
+    bool QuestEffectBeacon::execute(bool bTriggered, BaseObject* trigger)
+    {
+        if(!bTriggered)
         {
             return false;

code/branches/doc/src/modules/questsystem/QuestEffectBeacon.h

@@ -90 +90 @@
             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.
 
             /**