Changeset 5833 for code/branches/tutorial/src/orxonox/controllers

Timestamp:

Sep 29, 2009, 10:24:39 PM (15 years ago)

Author:

dafrick

Message:

Added some more comments to the tutorial.

Location:

code/branches/tutorial/src/orxonox/controllers

Files:

• DroneController.cc (modified) (2 diffs)
• DroneController.h (modified) (2 diffs)

code/branches/tutorial/src/orxonox/controllers/DroneController.cc

@@ -34 +34 @@
 namespace orxonox
 {
+    /**
+    @brief
+        Constructor.
+    */
     DroneController::DroneController(BaseObject* creator) : Controller(creator)
     {
@@ -51 +55 @@
     }
 
+    /**
+    @brief
+        The controlling happens here. This method defines what the controller has to do each tick.
+    @param dt
+        The duration of the tick.
+    */
     void DroneController::tick(float dt)
     {

code/branches/tutorial/src/orxonox/controllers/DroneController.h

@@ -37 +37 @@
 namespace orxonox
 {
+    /**
+    @brief
+        Controller for the Drone of the PPS tutorial.
+    @author
+        Oli Scheuss
+    */
     class _OrxonoxExport DroneController : public Controller, public Tickable
     {
@@ -43 +49 @@
             virtual ~DroneController();
             
-            virtual void tick(float dt);
+            virtual void tick(float dt); //!< The controlling happens here. This method defines what the controller has to do each tick.
 
         protected: