Changeset 7601 for code/trunk/src/modules/objects/triggers/DistanceTriggerBeacon.h

Timestamp:

Oct 30, 2010, 1:54:49 PM (14 years ago)

Author:

dafrick

Message:

Adding all classes in modules/objects to Objects module (in doxygen).
Created TriggerBase which is the base class of Trigger and MultiTrigger and now provides the shared functionality and data.
Updated some of the documentation in MultiTrigger and Script.

File:

• code/trunk/src/modules/objects/triggers/DistanceTriggerBeacon.h (modified) (2 diffs)

code/trunk/src/modules/objects/triggers/DistanceTriggerBeacon.h

@@ -30 +30 @@
     @file DistanceTriggerBeacon.h
     @brief Definition of the DistanceTriggerBeacon class.
+    @ingroup Triggers
 */
 
@@ -44 +45 @@
     /**
     @brief
-        A DistanceTriggerBeacon can be used together with a DistanceTrigger or a DistanceMultiTrigger to make them only react to specific objects.
-        This can be done by attaching a DistanceTriggerBeacon to an object, giving it a unique name and setting the targetname in the DistanceTrigger (or DistanceMultiTrigger) to that name and the target to DistanceTriggerBeacon.
+        A DistanceTriggerBeacon can be used together with a @ref orxonox::DistanceTrigger "DistanceTrigger" or a @ref orxonox::DistanceMultiTrigger "DistanceMultiTrigger" to make them only react to specific objects.
+        This can be done by attaching a DistanceTriggerBeacon to an object, giving it a unique name and setting the targetname in the @ref orxonox::DistanceTrigger "DistanceTrigger" (or @ref orxonox::DistanceMultiTrigger "DistanceMultiTrigger") to that name and the target to DistanceTriggerBeacon.
+
     @author
         Damian 'Mozork' Frick
+
+    @ingroup Triggers
     */
     class _ObjectsExport DistanceTriggerBeacon : public StaticEntity