Diff: RC_Servo.h

Revision:

3:398efc75d72b

Parent:

2:a762abad6301

Child:

4:c21c2e0d926f

diff -r a762abad6301 -r 398efc75d72b RC_Servo.h
--- a/RC_Servo.h	Tue May 22 15:28:07 2018 +0000
+++ b/RC_Servo.h	Tue May 22 16:57:35 2018 +0000
@@ -37,12 +37,14 @@
 #define Servo_H
 
 /**
- * Includes
+ * Includes : Mbed Library
  */
 #include "mbed.h"
 
 /**
- * RC_Servo Class
+ * RC_Servo
+ * Analog servomotor (without external feedback)
+ * More information : http://www.digitalspirit.org/wiki/docs/servo-moteurs
  */
 class RC_Servo
 {
@@ -58,10 +60,10 @@
     RC_Servo(PinName PWM, int _extended = 0);
 
     /**
-     * Set the min and max time associeted with both position
+     * Set the min and max time associeted with both extreme position
      *
-     * @param Tmin pulsewidth (in us) associated with Min position (must be more than 400)
-     * @param Tmax pulsewidth (in us) associated with Max position (must be less than 2400)
+     * @param Tmin : pulsewidth (in us) associated with Min position (must be more than 400)
+     * @param Tmax : pulsewidth (in us) associated with Max position (must be less than 2400)
      * @return 0 if OK, any other value if FAIL
      */
     int setLimits (int Tmin, int Tmax);
@@ -69,7 +71,7 @@
     /**
      * Set the position of the Servo
      *
-     * @param position float number between 0 and 1 (0 = Min, 1 = Max)
+     * @param position : float number between 0 and 1 (0 = Min, 1 = Max)
      */
     void write (float position);