removed X-NUCLEO-COMMON and ST-INTERFACES
Dependents: unh-hackathon-example unh-hackathon-example-raw
Fork of X_NUCLEO_IKS01A1 by
Diff: Components/lps25h/lps25h_class.h
- Revision:
- 57:04563dd74269
- Parent:
- 54:2a676c734b30
- Child:
- 88:7b8d3316d753
--- a/Components/lps25h/lps25h_class.h Wed Jun 10 18:03:42 2015 +0200 +++ b/Components/lps25h/lps25h_class.h Mon Jun 15 10:28:49 2015 +0200 @@ -41,9 +41,9 @@ /* Includes ------------------------------------------------------------------*/ #include "mbed.h" #include "DevI2C.h" +#include "lps25h.h" #include "../Interfaces/PressureSensor.h" #include "../Interfaces/TempSensor.h" -#include "lps25h.h" /* Classes -------------------------------------------------------------------*/ /** Class representing a LPS25H sensor component @@ -122,7 +122,7 @@ /** * @brief Configures LPS25H I2C interface - * @retval PRESSURE_OK in case of success, an error code otherwise + * @return PRESSURE_OK in case of success, an error code otherwise */ PRESSURE_StatusTypeDef LPS25H_IO_Init(void) { @@ -130,12 +130,12 @@ } /** - * @brief Utility function to read data from LPS25H - * @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 PRESSURE_OK if ok, - * @retval PRESSURE_ERROR if an I2C error has occured + * @brief Utility function to read data from LPS25H + * @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 PRESSURE_OK if ok, + * @retval PRESSURE_ERROR if an I2C error has occured */ PRESSURE_StatusTypeDef LPS25H_IO_Read(uint8_t* pBuffer, uint8_t RegisterAddr, uint16_t NumByteToRead) @@ -151,12 +151,12 @@ } /** - * @brief Utility function to write data to LPS25H - * @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 PRESSURE_OK if ok, - * @retval PRESSURE_ERROR if an I2C error has occured + * @brief Utility function to write data to LPS25H + * @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 PRESSURE_OK if ok, + * @retval PRESSURE_ERROR if an I2C error has occured */ PRESSURE_StatusTypeDef LPS25H_IO_Write(uint8_t* pBuffer, uint8_t RegisterAddr, uint16_t NumByteToWrite)