Changeset 8447 for code/branches/tutoriallevel2/src/modules/objects/triggers

Timestamp:

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

Author:

dafrick

Message:

Resolving some doxygen warnings.

Location:

code/branches/tutoriallevel2/src/modules/objects/triggers

Files:

• DistanceTrigger.cc (modified) (1 diff)
• DistanceTrigger.h (modified) (1 diff)
• EventTrigger.h (modified) (1 diff)

code/branches/tutoriallevel2/src/modules/objects/triggers/DistanceTrigger.cc

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

code/branches/tutoriallevel2/src/modules/objects/triggers/DistanceTrigger.h

@@ -71 +71 @@
         - @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/branches/tutoriallevel2/src/modules/objects/triggers/EventTrigger.h

@@ -60 +60 @@
 
     @see Trigger
-        For more information on @ref oroxnox::Trigger "Triggers".
+        For more information on @ref orxonox::Trigger "Triggers".
 
     @author