Diff: lib_PwmOutAllPin.h

Revision:

4:22942b7e1635

Parent:

3:1d1669e8c9b1

Child:

5:0f5ad06f23c0

--- a/lib_PwmOutAllPin.h	Fri Oct 23 08:16:58 2015 +0000
+++ b/lib_PwmOutAllPin.h	Wed May 04 10:54:33 2016 +0000
@@ -37,18 +37,56 @@
 class PwmOutAllPin : public Timeout
 {
 	public:
+	/** Crée un PwmOutAllPin connecté à la pin spécifiée
+	 *
+	 *  @param pin Pin à connecter
+	 */
     PwmOutAllPin(PinName pin);
-	
+	/** Fixe le rapport cyclique au pourcentage (float) spécifié
+	 *
+	 *  @param value Une valeure floating-point représentant le rapport cyclique,
+	 *    spécifié sous la forme d'un pourcentage. La valeur doit être comprise entre
+	 *    0.0f (correspondant à 0%) et 1.0f (correspondant à 100%).
+	 *    Les valeurs exterieures à cette plage sont saturées à 0.0f ou 1.0f.
+	 */
 	void write(float value);
+	/** Retourne la valeur courante du rapport cyclique de la sortie, mesurée sous la forme d'un pourcentage (float)
+	 *
+	 *  @returns
+	 *    Une valeur floating-point représentant la valeur courante du rapport cyclique qui est sur la pin de sortie,
+	 *    mesurée sous la forme d'un pourcentage. La valeur doit être comprise entre
+	 *    0.0f (correspondant à 0%) et 1.0f (correspondant à 100%).
+	 */
 	float read(void);
+	/** Fixe la période du PWM, spécifié en secondes (float), garde le même rapport cyclique.
+	 *
+	 *  @note
+	 *   La résolution est en microsecondes mais les périodes inférieure à 100µs sont imprécises.
+	 */
 	void period(float seconds);
+	/** Fixe la période du PWM, spécifié en millisecondes (int), garde le même rapport cyclique.
+	 */
 	void period_ms(int ms);
+	/** Fixe la période du PWM, spécifié en microsecondes (int), garde le même rapport cyclique.
+	 */
 	void period_us(int us);
+	/** Fixe la largeur d'impulsion du PWM, spécifié en secondes (float), garde la même période.
+	 */
 	void pulsewidth(float seconds);
+	/** Fixe la largeur d'impulsion du PWM, spécifié en millisecondes (int), garde la même période.
+	 */
 	void pulsewidth_ms(int ms);
+	/** Fixe la largeur d'impulsion du PWM, spécifié en microsecondes (int), garde la même période.
+	 */
 	void pulsewidth_us(int us);
+	/** raccourci pour write()
+	*/
 	PwmOutAllPin& operator= (float value);
+	/** raccourci pour effectuer des opperations mathématique avec write()
+	*/ 
 	PwmOutAllPin& operator= (PwmOutAllPin& rhs);
+	/** raccourci pour read()
+	 */
 	operator float();
 
 	protected: