Diff: StateDefines/State.h

Revision:

3:92ba0254af87

Parent:

2:d8e1613dc38b

Child:

6:48eeb41188dd

--- a/StateDefines/State.h	Sun Mar 03 16:26:47 2013 +0000
+++ b/StateDefines/State.h	Thu Mar 07 09:47:07 2013 +0000
@@ -22,6 +22,7 @@
  *
  * State is the main mechanism for communicating current realtime system state to
  * the rest of the system for logging etc.
+ * 
  */
 
 class State : public Task
@@ -42,16 +43,15 @@
 
 public:
 
-
     /**
      * Creates a robot control object and initializes all private state variables.
-     * @param s struct to read and write the state.
-     * @param robotControl Object to read the state.
-     * @param motorControllerLeft a reference to the servo drive for the left motor.
-     * @param motorControllerRight a reference to the servo drive for the right motor.
+     * @param s struct to read and write the state
+     * @param robotControl Object to read the state
+     * @param motorControllerLeft a reference to the servo drive for the left motor
+     * @param motorControllerRight a reference to the servo drive for the right motor
      * @param compass Modul HMC5883L
      * @param battery Analog Input Battery Voltage input
-     * @param period the sampling period of the run loop of this controller, given in [s].
+     * @param period the sampling period of the run loop of this controller, given in [s]
      */
     State(state_t* s, RobotControl* robotControl, MaxonESCON* motorControllerLeft, MaxonESCON* motorControllerRight, /*HMC6352* compass,*/ AnalogIn* battery, float period);
 
@@ -61,7 +61,7 @@
     virtual     ~State();
     
     /**
-     * Initzialize the File. Open the File plots.txt and set the title at first line
+     * Initzialize the File. Open the File plots.txt and set the title at first line.
      */
     void initPlotFile(void);
 
@@ -73,7 +73,7 @@
     void savePlotText(char text[]);
 
     /**
-    * Close the File
+    * Close the File.
     */
     void closePlotFile(void);
 
@@ -85,19 +85,18 @@
     float readBattery();
 
      /**
-     * Starts the timer from zero
+     * Starts the timer from zero.
      * The timer is for the logging Time.
      */
     void startTimerFromZero();
 
     /**
-    * Save the new state to a new line
+    * Save the new state to a new line.
     */
     void savePlotFile(state_t s);
 
     void        run();
 
-
 private:
 
     void setBatteryBit();