Ricardo Heers
/
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 X_NUCLEO_IKS01A1 ST_INTERFACES
Diff: Components/Common/MagneticSensor.h
- Revision:
- 32:2bb1d4ced32b
- Parent:
- 30:7b36639ee80a
--- a/Components/Common/MagneticSensor.h Thu Jun 04 13:46:35 2015 +0200 +++ b/Components/Common/MagneticSensor.h Thu Jun 04 14:01:31 2015 +0200 @@ -52,14 +52,14 @@ /** * @brief Initialization of magnetometer * @param[out] ptr Pointer to device specific initalization structure - * @retval 0 in case of success, an error code otherwise + * @return 0 in case of success, an error code otherwise */ virtual int Init(void *ptr) = 0; /** * @brief Get ID of magnetometer * @param[out] id Pointer to where to store the ID to - * @retval 0 in case of success, an error code otherwise + * @return 0 in case of success, an error code otherwise */ virtual int ReadID(uint8_t *id) = 0; @@ -71,7 +71,7 @@ * pData[0] corresponds to X-axis, * pData[1] corresponds to Y-axis, and * pData[2] corresponds to Z-axis. - * @retval 0 in case of success, an error code otherwise + * @return 0 in case of success, an error code otherwise */ virtual int Get_M_Axes(int32_t *pData) = 0; @@ -83,7 +83,7 @@ * pData[0] corresponds to X-axis, * pData[1] corresponds to Y-axis, and * pData[2] corresponds to Z-axis. - * @retval 0 in case of success, an error code otherwise + * @return 0 in case of success, an error code otherwise */ virtual int Get_M_AxesRaw(int16_t *pData) = 0; };