Changeset 10929 for code/branches/hoverHS15/src/modules/hover/TimeHUD.cc

Timestamp:

Dec 7, 2015, 2:26:27 PM (8 years ago)

Author:

bucyril

Message:

Added documentation

File:

• code/branches/hoverHS15/src/modules/hover/TimeHUD.cc (modified) (3 diffs)

code/branches/hoverHS15/src/modules/hover/TimeHUD.cc

@@ -24 +24 @@
  *
  */
+
+/**
+    @file TimeHUD.cc
+    @brief Implementation of the TimeHUD
+*/
+
 
 #include "TimeHUD.h"
@@ -102 +108 @@
     }
 
+    /**
+    @brief
+        sets if the clock is running
+    @param running
+    */
     void TimeHUD::setRunning(bool running) 
     {
@@ -107 +118 @@
     }
 
+    /**
+    @brief
+        returns if the clock is running
+    @returns running
+    */
     bool TimeHUD::isRunning() {
         return this->_running;