Diff: ak7451.h

Revision:

2:b1079549c6a1

Parent:

1:536cf25b0eb4

Child:

3:1e0cfed43467

--- a/ak7451.h	Mon Sep 12 17:23:27 2016 +0000
+++ b/ak7451.h	Tue Nov 01 17:48:23 2016 +0000
@@ -4,7 +4,7 @@
 #include "mbed.h"
 
 /**
- * This is a device driver of AK7451.
+ * This is a device driver of AK7451 with SPI interface.
  *
  * @note AK7451 is a high speed angle sensor IC manufactured by AKM.
  * 
@@ -27,20 +27,20 @@
      * Available opration modes in AK7451.
      */
     typedef enum {
-        AK7451_NORMAL_MODE  = 0x0000,
-        AK7451_USER_MODE    = 0x050F,
+        AK7451_NORMAL_MODE  = 0x0000,   /**< Normal mode operation. */
+        AK7451_USER_MODE    = 0x050F,   /**< User mode operation. */
     } OperationMode;
 
     /**
      * Status of function. 
      */
     typedef enum {
-        SUCCESS,               /**< The function processed successfully. */
-        ERROR,                 /**< General Error */
-        ERROR_IN_USER_MODE,
-        ERROR_IN_NORMAL_MODE,
-        ERROR_PARITY,
-        ERROR_ABNORMAL_STRENGTH,
+        SUCCESS,                    /**< The function processed successfully. */
+        ERROR,                      /**< General Error */
+        ERROR_IN_USER_MODE,         /**< Error in user mode. */
+        ERROR_IN_NORMAL_MODE,       /**< Error in normal mode. */
+        ERROR_PARITY,               /**< Parity bit error. */
+        ERROR_ABNORMAL_STRENGTH,    /**< Abnormal strength error. */
     } Status;
 
     /**