Mike Fiore / X_NUCLEO_IKS01A1

removed X-NUCLEO-COMMON and ST-INTERFACES

Dependents:   unh-hackathon-example unh-hackathon-example-raw

Fork of X_NUCLEO_IKS01A1 by ST

Files at this revision

API Documentation at this revision

Revision 36:8c73dbe43cf2, committed 2015-06-04

Comitter:
Wolfgang Betz
Date:
Thu Jun 04 14:09:11 2015 +0200
Parent:
32:2bb1d4ced32b
Child:
37:8e8d9427c78b
Child:
38:e06de1c26727
Commit message:
Minor doxygen experiment

Changed in this revision

Components/lis3mdl/lis3mdl_class.h Show annotated file Show diff for this revision Revisions of this file 
--- 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)
 	{
@@ -101,10 +98,11 @@
 
 	/**
 	 * @brief utility function to read data from STC3115
-	 * @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
+	 * @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
+	 * @retval MAGNETO_ERROR if an I2C error has occured
 	 */
 	MAGNETO_StatusTypeDef LIS3MDL_IO_Read(uint8_t* pBuffer, 
 					      uint8_t RegisterAddr, uint16_t NumByteToRead)
@@ -121,10 +119,11 @@
 	
 	/**
 	 * @brief utility function to write data to STC3115
-	 * @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
+	 * @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
+	 * @retval -1 if an I2C error has occured
 	 */
 	MAGNETO_StatusTypeDef LIS3MDL_IO_Write(uint8_t* pBuffer, 
 					       uint8_t RegisterAddr, uint16_t NumByteToWrite)