Diff: Actuators/MaxonESCON/MaxonESCON.h

Revision:

1:6cd533a712c6

Parent:

0:31f7be68e52d

Child:

2:d8e1613dc38b

--- a/Actuators/MaxonESCON/MaxonESCON.h	Thu Feb 07 17:43:19 2013 +0000
+++ b/Actuators/MaxonESCON/MaxonESCON.h	Sat Mar 02 09:39:34 2013 +0000
@@ -10,7 +10,7 @@
  *
  * @section LICENSE
  *
- * Copyright (c) 2013 HSLU Pren Team #1 Cruising Crêpe
+ * Copyright © 2013 HSLU Pren Team #1 Cruising Crêpe
  * All rights reserved.
  *
  * @section DESCRIPTION
@@ -49,8 +49,9 @@
        * @param enb DigitalOut, set high for enable
        * @param isenb DigitalIn, high for enable
        * @param pwm PwmOut pin, set the Velocity
-       * @param hall1 HALL Object
-       * @param Actual Speed AnalogIn Filtered Signal for ActualSpeed from Motor
+       * @param hall HALL Object
+       * @param actualSpeed AnalogIn Filtered Signal for ActualSpeed from Motor
+       * @param hall The Object of the Hallsensor from Motor
        */
     MaxonESCON(PinName enb,
                PinName isenb,
@@ -60,7 +61,7 @@
 
     /** Set the speed of the motor with a pwm for 10%..90%
     *  50% PWM is 0rpm
-    *  Caclulate from 1/s in 1/min plus the Facotr of the ESCON
+    *  Caclulate from [1/s] in [1/min] and the Factor of the ESCON
     * @param speed The speed of the motor as a normalised value in [1/s]
     */
     void setVelocity(float speed);
@@ -77,13 +78,13 @@
     *
     * Wrapper for PwmOut::period()
     *
-    * @param seconds - Pwm duty cycle in seconds.
+    * @param period Pwm duty cycle in seconds.
     */
     void period(float period);
 
     /** Set the Motor to a enable sate
     *
-    * @param enable - 0 for disable 1 for enable.
+    * @param enb <code>0</code> for disable <code>1</code> for enable.
     */
     void enable (bool enb);