Yong Jee / X_NUCLEO_IKS01A1

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   X_NUCLEO_COMMON ST_INTERFACES

Dependents:   test2

Diff: Components/lis3mdl/lis3mdl_class.h

Revision:
54:2a676c734b30
Parent:
50:f507d4465c31
Child:
57:04563dd74269
diff -r 54553fd15b50 -r 2a676c734b30 Components/lis3mdl/lis3mdl_class.h
--- a/Components/lis3mdl/lis3mdl_class.h	Wed Jun 10 16:44:54 2015 +0200
+++ b/Components/lis3mdl/lis3mdl_class.h	Wed Jun 10 18:03:42 2015 +0200
@@ -50,7 +50,7 @@
 class LIS3MDL : public MagneticSensor {
  public:
 	/** Constructor
-	 * @param i2c device I2C to be used for communication
+	 * @param[in] i2c device I2C to be used for communication
 	 */
         LIS3MDL(DevI2C &i2c) : MagneticSensor(), dev_i2c(i2c) {
 	}
@@ -101,11 +101,11 @@
 	}
 
 	/**
-	 * @brief utility function to read data from STC3115
-	 * @param  pBuffer pointer to data to be read.
+	 * @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_OK if ok, 
 	 * @retval MAGNETO_ERROR if an I2C error has occured
 	 */
 	MAGNETO_StatusTypeDef LIS3MDL_IO_Read(uint8_t* pBuffer, 
@@ -122,11 +122,11 @@
 	}
 	
 	/**
-	 * @brief utility function to write data to STC3115
-	 * @param  pBuffer pointer to buffer to be filled.
+	 * @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_OK if ok, 
 	 * @retval MAGNETO_ERROR if an I2C error has occured
 	 */
 	MAGNETO_StatusTypeDef LIS3MDL_IO_Write(uint8_t* pBuffer,