Changeset 7601 for code/trunk/src/orxonox/interfaces/PlayerTrigger.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/orxonox/interfaces/PlayerTrigger.h (modified) (4 diffs)

code/trunk/src/orxonox/interfaces/PlayerTrigger.h

@@ -28 +28 @@
 
 /**
-    @file
-    @brief
-    Definition of the PlayerTrigger class.
+    @file PlayerTrigger.h
+    @brief Definition of the PlayerTrigger class.
+    @ingroup Triggers
 */
 
@@ -37 +37 @@
 
 #include "OrxonoxPrereqs.h"
+
 #include "core/OrxonoxClass.h"
 
@@ -43 +44 @@
     /**
     @brief
-        A PlayerTrigger is a trigger which is normally triggered by Pawns and can as such return a pointer to the Pawn which triggered it.
+        PlayerTrigger is an interface if implemented by a specific trigger can be used to recover the Player (or more precisely the @ref orxonox::Pawn "Pawn") that triggered it.
+
     @author
         Damian 'Mozork' Frick
+
+    @ingroup Triggers
     */
     class _OrxonoxExport PlayerTrigger : virtual public OrxonoxClass
@@ -75 +79 @@
            { this->player_ = player; }
 
-            /**
-            @brief Set whether the PlayerTrigger normally is triggered by Pawns.
-            @param isForPlayer Should be true when the PlayerTrigger should be set to normally be triggered by Pawns, false if not.
-            */
+        /**
+        @brief Set whether the PlayerTrigger normally is triggered by Pawns.
+        @param isForPlayer Should be true when the PlayerTrigger should be set to normally be triggered by Pawns, false if not.
+        */
         inline void setForPlayer(bool isForPlayer)
            { this->isForPlayer_ = isForPlayer; }