Manuel Caballero / ADXL345
Revision:
1:186b5a33dce3
Parent:
0:5e0fa5be068d
Child:
2:b96d481934ae
--- a/ADXL345.h	Sat Aug 19 08:13:41 2017 +0000
+++ b/ADXL345.h	Sat Aug 19 08:18:27 2017 +0000
@@ -1,6 +1,6 @@
 /**
  * @brief       ADXL345.h
- * @details     3-Axis, ±2 g/±4 g/±8 g/±16 g Digital Accelerometer ( Analog Devices ).
+ * @details     3-Axis, ±2 g/±4 g/±8 g/±16 g Digital Accelerometer.
  *              Header file.
  *
  *
@@ -9,7 +9,9 @@
  * @author      Manuel Caballero
  * @date        19/August/2017
  * @version     19/August/2017    The ORIGIN
- * @pre         NaN
+ * @pre         Although the ADXL345 can be handled by SPI or I2C, this library is only
+ *              adapted to be used by I2C.
+ * @pre         FIFO functions are NOT implemented.
  * @warning     NaN
  * @pre         This code belongs to AqueronteBlog ( http://unbarquero.blogspot.com ).
  */
@@ -352,17 +354,17 @@
 #ifndef VECTOR_STRUCT_H
 #define VECTOR_STRUCT_H
     typedef struct {
-        int16_t XAxis;
-        int16_t YAxis;
-        int16_t ZAxis;
-    } Vector_t;
+        int16_t XAxis;                                                          /*!<  X-axis raw data                                                 */
+        int16_t YAxis;                                                          /*!<  Y-axis raw data                                                 */
+        int16_t ZAxis;                                                          /*!<  Z-axis raw data                                                 */
+    } Vector_t;                                                                 /*!<  Struct to get the raw data                                      */
 
 
     typedef struct {
-        float Xmg_Axis;
-        float Ymg_Axis;
-        float Zmg_Axis;
-    } Vector_f;
+        float Xmg_Axis;                                                         /*!<  X-axis scaled data                                              */
+        float Ymg_Axis;                                                         /*!<  X-axis scaled data                                              */
+        float Zmg_Axis;                                                         /*!<  X-axis scaled data                                              */
+    } Vector_f;                                                                 /*!<  Struct to get the scaled data                                   */
 #endif