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.
Dependents: iks01a1_acc LoRaWAN-demo-72_mdotIKS01A1 MTDOT-UDKDemo_Senet MTDOT-UDKDemo
Fork of
X_NUCLEO_IKS01A1
by 
ST
Diff: Components/lis3mdl/lis3mdl_class.h
- Revision:
- 34:ed7ca069781e
- Parent:
- 24:92cc9c6e4b2b
- Child:
- 37:8e8d9427c78b
--- a/Components/lis3mdl/lis3mdl_class.h Thu Jun 04 14:01:31 2015 +0200
+++ b/Components/lis3mdl/lis3mdl_class.h Thu Jun 04 14:09:11 2015 +0200
@@ -81,8 +81,6 @@
/**
* @brief Configures LIS3MDL interrupt lines for NUCLEO boards
- * @param None
- * @retval None
*/
void LIS3MDL_IO_ITConfig(void)
{
@@ -91,8 +89,7 @@
/**
* @brief Configures LIS3MDL I2C interface
- * @param None
- * @retval MAGNETO_OK in case of success, an error code otherwise
+ * @return MAGNETO_OK in case of success, an error code otherwise
*/
MAGNETO_StatusTypeDef LIS3MDL_IO_Init(void)
{
@@ -104,7 +101,8 @@
* @param pBuffer: pointer to data to be read.
* @param RegisterAddr: specifies internal address register to read from.
* @param NumByteToRead: number of bytes to be read.
- * @retval MAGNETO_OK if ok, MAGNETO_ERROR if an I2C error has occured
+ * @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)
@@ -124,7 +122,8 @@
* @param pBuffer: pointer to buffer to be filled.
* @param RegisterAddr: specifies internal address register to read from.
* @param NumByteToWrite: number of bytes to write.
- * @retval 0 if ok, -1 if an I2C error has occured
+ * @retval 0 if ok
+ * @retval -1 if an I2C error has occured
*/
MAGNETO_StatusTypeDef LIS3MDL_IO_Write(uint8_t* pBuffer,
uint8_t RegisterAddr, uint16_t NumByteToWrite)