Diff: Components/lis3mdl/lis3mdl_class.h

Revision:

57:04563dd74269

Parent:

54:2a676c734b30

Child:

88:7b8d3316d753

diff -r 2a676c734b30 -r 04563dd74269 Components/lis3mdl/lis3mdl_class.h
--- a/Components/lis3mdl/lis3mdl_class.h	Wed Jun 10 18:03:42 2015 +0200
+++ b/Components/lis3mdl/lis3mdl_class.h	Mon Jun 15 10:28:49 2015 +0200
@@ -41,8 +41,8 @@
 /* Includes ------------------------------------------------------------------*/
 #include "mbed.h"
 #include "DevI2C.h"
+#include "lis3mdl.h"
 #include "../Interfaces/MagneticSensor.h"
-#include "lis3mdl.h"
 
 /* Classes -------------------------------------------------------------------*/
 /** Class representing a LIS3MDL sensor component
@@ -101,12 +101,12 @@
 	}
 
 	/**
-	 * @brief  Utility function to read data from LIS3MDL
-	 * @param  pBuffer pointer to the byte-array to read data in to
-	 * @param  RegisterAddr specifies internal address register to read from.
-	 * @param  NumByteToRead number of bytes to be read.
-	 * @retval MAGNETO_OK if ok, 
-	 * @retval MAGNETO_ERROR if an I2C error has occured
+	 * @brief      Utility function to read data from LIS3MDL
+	 * @param[out] pBuffer pointer to the byte-array to read data in to
+	 * @param[in]  RegisterAddr specifies internal address register to read from.
+	 * @param[in]  NumByteToRead number of bytes to be read.
+	 * @retval     MAGNETO_OK if ok, 
+	 * @retval     MAGNETO_ERROR if an I2C error has occured
 	 */
 	MAGNETO_StatusTypeDef LIS3MDL_IO_Read(uint8_t* pBuffer, 
 					      uint8_t RegisterAddr, uint16_t NumByteToRead)
@@ -122,12 +122,12 @@
 	}
 	
 	/**
-	 * @brief  Utility function to write data to LIS3MDL
-	 * @param  pBuffer pointer to the byte-array data to send
-	 * @param  RegisterAddr specifies internal address register to read from.
-	 * @param  NumByteToWrite number of bytes to write.
-	 * @retval MAGNETO_OK if ok, 
-	 * @retval MAGNETO_ERROR if an I2C error has occured
+	 * @brief      Utility function to write data to LIS3MDL
+	 * @param[in]  pBuffer pointer to the byte-array data to send
+	 * @param[in]  RegisterAddr specifies internal address register to read from.
+	 * @param[in]  NumByteToWrite number of bytes to write.
+	 * @retval     MAGNETO_OK if ok, 
+	 * @retval     MAGNETO_ERROR if an I2C error has occured
 	 */
 	MAGNETO_StatusTypeDef LIS3MDL_IO_Write(uint8_t* pBuffer, 
 					       uint8_t RegisterAddr, uint16_t NumByteToWrite)