Diff: PCA9629.h

Revision:

1:b3d94e04adfa

Parent:

0:77dbce152406

Child:

2:2d07f1c46eb3

--- a/PCA9629.h	Thu Feb 02 05:10:19 2012 +0000
+++ b/PCA9629.h	Thu Feb 02 05:23:12 2012 +0000
@@ -1,3 +1,15 @@
+/** A sample code for PCA9629
+ *
+ *  @author  Tedd OKANO, NXP Semiconductors
+ *  @version 1.0
+ *  @date    03-Feb-2011
+ *
+ *  Released under the MIT License: http://mbed.org/license/mit
+ *
+ *  An operation sample of PCU9629 stepper motor controller.
+ *  The mbed accesses the PCU9629 registers through I2C.
+ */
+
 #ifndef        MBED_PCA9629
 #define        MBED_PCA9629
 
@@ -45,6 +57,11 @@
 #define        INIT_VALUE__LOOPDLY       0x00;
 #define        INIT_VALUE__MCNTL         0x00;
 
+
+/** PCA9629 class
+ *
+ */
+ 
 class PCA9629 {
 public:
 
@@ -127,7 +144,7 @@
         PRESCALER_FROM_0_32_TO_2604,    /**< Prescaler range from 384us(  2604pps) to 3145.728ms( 0.32pps) */
     } PrescalerRange;
 
-    /** Create a PCA9629 object connected to specified I2C pins with specified address
+    /** Create a PCA9629 instance connected to specified I2C pins with specified address
      *
      * @param I2C_sda I2C-bus SDA pin
      * @param I2C_scl I2C-bus SCL pin
@@ -139,9 +156,9 @@
         char    I2C_address = PCA9629_DEFAULT_ADDR
     );
 
-    /** 
+    /**
      *
-     * 
+     *
      */
     void init_registers( void );