Christian Burri / Mbed 2 deprecated autonomousRobotAndroid

This program is for an autonomous robot for the competition at the Hochschule Luzern. We are one of the 32 teams. <a href="http://cruisingcrepe.wordpress.com/">http://cruisingcrepe.wordpress.com/</a> The postition control is based on this Documentation: Control of Wheeled Mobile Robots: An Experimental Overview from Alessandro De Luca, Giuseppe Oriolo, Marilena Vendittelli. For more information see here: <a href="http://www.dis.uniroma1.it/~labrob/pub/papers/Ramsete01.pdf">http://www.dis.uniroma1.it/~labrob/pub/papers/Ramsete01.pdf</a>

Dependencies:   mbed

Fork of autonomousRobotAndroid by Christian Burri

Diff: Actuators/Hallsensor.h

Revision:
11:775ebb69d5e1
Parent:
6:48eeb41188dd
diff -r 09ddb819fdcb -r 775ebb69d5e1 Actuators/Hallsensor.h
--- a/Actuators/Hallsensor.h	Thu Apr 04 06:43:43 2013 +0000
+++ b/Actuators/Hallsensor.h	Fri Apr 05 10:58:42 2013 +0000
@@ -6,12 +6,10 @@
 /**
  * @author Christian Burri
  *
- * @section LICENSE
- *
- * Copyright &copy; 2013 HSLU Pren Team #1 Cruising Crêpe
+ * @copyright Copyright &copy; 2013 HSLU Pren Team #1 Cruising Crêpe
  * All rights reserved.
  *
- * @section DESCRIPTION
+ * @brief
  *
  * Interface to count the Hallsensor input from a EC-Motor.
  *
@@ -22,7 +20,7 @@
 private:
 
     /**
-     * Update the pulse count.
+     * @brief Update the pulse count.
      * Called on every rising/falling edge of Hall 1-3.
      * Reads the state of the channels and determines whether a pulse forward
      * or backward has occured, updating the count appropriately.
@@ -41,7 +39,7 @@
 public:
 
     /**
-     * Constructor of the class <code>Hallsensor</code>.
+     * @brief Constructor of the class <code>Hallsensor</code>.
      *
      * Reads the current values on Hall1 , Hall2 and Hall3 to determine the
      * initial state.
@@ -54,19 +52,19 @@
     Hallsensor(PinName hall1, PinName hall2, PinName hall3);
 
     /**
-     * Reset the encoder.
+     * @brief Reset the encoder.
      * Sets the pulses and revolutions count to zero.
      */
     void reset(void);
 
     /**
-     * Read the number of pulses recorded by the encoder.
+     * @brief Read the number of pulses recorded by the encoder.
      * @return Number of pulses which have occured, given in [count]
      */
     int getPulses(void);
 
     /**
-     * Read the number of revolutions recorded by the encoder.
+     * @brief Read the number of revolutions recorded by the encoder.
      * @return Number of revolutions which have occured on the index channel.
      */
     int getRevolutions(void);