Diff: SMC02B.h

Revision:

2:d14838eb6b4b

Parent:

1:683f2848e917

Child:

3:8595605248a3

--- a/SMC02B.h	Mon Oct 11 18:49:41 2010 +0000
+++ b/SMC02B.h	Mon Oct 11 18:55:43 2010 +0000
@@ -54,11 +54,32 @@
 #define SMC02B_MOTOR2_SPEED     0x00
 #define SMC02B_MOTOR2_NUMBER    0x00
 
-class SMC02B
-{
+class SMC02B {
+
 public:
+
+    /**
+     * Constructor.
+     *
+     * @param tx mbed pin to use for TX line of Serial interface.
+     * @param rx mbed pin to use for RX line of Serial interface.
+     * @param rst mbed pin to use for RST line.
+     */
     SMC02B(PinName tx, PinName rx, PinName pin);
+    
+    /**
+     * Reset SMC02B.
+     *
+     */    
     void SMC02B_RST(void);
+
+    /**
+     * Set Motor.
+     *
+     * @param motor Motor number.
+     * @param Direction Motor Direction.
+     * @param speed Motor Speed.
+     */
     void SMC02B_MOTOR_SET( char motor, char direction, char speed );
     void SMC02B_MOTOR_BRAKE( char motor );
     void SMC02B_MOTOR_COAST( char motor );