LE YOU
/
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.
Fork of
X_NUCLEO_IKS01A1
by 
ST
Revision 32:2bb1d4ced32b, committed 2015-06-04
- Comitter:
- Wolfgang Betz
- Date:
- Thu Jun 04 14:01:31 2015 +0200
- Parent:
- 30:7b36639ee80a
- Child:
- 33:d2c283e85bd0
- Child:
- 34:ed7ca069781e
- Child:
- 36:8c73dbe43cf2
- Commit message:
- @retval -> @return
Changed in this revision
--- a/Components/Common/GyroSensor.h Thu Jun 04 13:46:35 2015 +0200 +++ b/Components/Common/GyroSensor.h Thu Jun 04 14:01:31 2015 +0200 @@ -52,14 +52,14 @@ /** * @brief Initialization of gyroscope * @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 gyroscope * @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_G_Axes(int32_t *pData) = 0; @@ -83,28 +83,28 @@ * 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_G_AxesRaw(int16_t *pData) = 0; /** * @brief Get gyroscope's current sensitivity [mdps/LSB] * @param[out] pfData Pointer to where the gyroscope's sensitivity is stored to - * @retval 0 in case of success, an error code otherwise + * @return 0 in case of success, an error code otherwise */ virtual int Get_G_Sensitivity(float *pfData) = 0; /** * @brief Get gyroscope's current output data rate [Hz] * @param[out] pfData Pointer to where the gyroscope output data rate is stored to - * @retval 0 in case of success, an error code otherwise + * @return 0 in case of success, an error code otherwise */ virtual int Get_G_ODR(float *pfData) = 0; /** * @brief Set gyroscope's output data rate * @param[in] odr New value for gyroscope's output data rate in [Hz] - * @retval 0 in case of success, an error code otherwise + * @return 0 in case of success, an error code otherwise */ virtual int Set_G_ODR(float odr) = 0; @@ -112,7 +112,7 @@ * @brief Get gyroscope's full scale value * i.e. min/max measurable value [dps] * @param[out] pfData Pointer to where the gyroscope full scale value is stored to - * @retval 0 in case of success, an error code otherwise + * @return 0 in case of success, an error code otherwise */ virtual int Get_G_FS(float *pfData) = 0; @@ -120,7 +120,7 @@ * @brief Set gyroscope's full scale value * i.e. min/max measurable value * @param[in] fs New full scale value for gyroscope in [dps] - * @retval 0 in case of success, an error code otherwise + * @return 0 in case of success, an error code otherwise */ virtual int Set_G_FS(float fs) = 0; };
--- a/Components/Common/HumiditySensor.h Thu Jun 04 13:46:35 2015 +0200 +++ b/Components/Common/HumiditySensor.h Thu Jun 04 14:01:31 2015 +0200 @@ -52,33 +52,33 @@ /** * @brief Initialization of humidity sensor * @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 Enter sensor shutdown mode - * @retval 0 in case of success, an error code otherwise + * @return 0 in case of success, an error code otherwise */ virtual int PowerOff(void) = 0; /** * @brief Get ID of humidity sensor * @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; /** * @brief Reset sensor - * @retval 0 in case of success, an error code otherwise + * @return 0 in case of success, an error code otherwise */ virtual int Reset(void) = 0; /** * @brief Get current humidity [%] * @param[out] pfData Pointer to where to store humidity to - * @retval 0 in case of success, an error code otherwise + * @return 0 in case of success, an error code otherwise */ virtual int GetHumidity(float *pfData) = 0;
--- 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; };
--- a/Components/Common/MotionSensor.h Thu Jun 04 13:46:35 2015 +0200 +++ b/Components/Common/MotionSensor.h Thu Jun 04 14:01:31 2015 +0200 @@ -52,14 +52,14 @@ /** * @brief Initialization of accelerometer * @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 accelerometer * @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_X_Axes(int32_t *pData) = 0; @@ -83,28 +83,28 @@ * 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_X_AxesRaw(int16_t *pData) = 0; /** * @brief Get accelerometer's current sensitivity [mg/LSB] * @param[out] pfData Pointer to where the accelerometer's sensitivity is stored to - * @retval 0 in case of success, an error code otherwise + * @return 0 in case of success, an error code otherwise */ virtual int Get_X_Sensitivity(float *pfData) = 0; /** * @brief Get accelerometer's current output data rate [Hz] * @param[out] pfData Pointer to where the accelerometer output data rate is stored to - * @retval 0 in case of success, an error code otherwise + * @return 0 in case of success, an error code otherwise */ virtual int Get_X_ODR(float *pfData) = 0; /** * @brief Set accelerometer's output data rate * @param[in] odr New value for accelerometer's output data rate in [Hz] - * @retval 0 in case of success, an error code otherwise + * @return 0 in case of success, an error code otherwise */ virtual int Set_X_ODR(float odr) = 0; @@ -112,7 +112,7 @@ * @brief Get accelerometer's full scale value * i.e. min/max measurable value [g] * @param[out] pfData Pointer to where the accelerometer full scale value is stored to - * @retval 0 in case of success, an error code otherwise + * @return 0 in case of success, an error code otherwise */ virtual int Get_X_FS(float *pfData) = 0; @@ -120,7 +120,7 @@ * @brief Set accelerometer's full scale value * i.e. min/max measurable value * @param[in] fs New full scale value for accelerometer in [g] - * @retval 0 in case of success, an error code otherwise + * @return 0 in case of success, an error code otherwise */ virtual int Set_X_FS(float fs) = 0; };
--- a/Components/Common/PressureSensor.h Thu Jun 04 13:46:35 2015 +0200 +++ b/Components/Common/PressureSensor.h Thu Jun 04 14:01:31 2015 +0200 @@ -52,33 +52,33 @@ /** * @brief Initialization of pressure sensor * @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 Enter sensor shutdown mode - * @retval 0 in case of success, an error code otherwise + * @return 0 in case of success, an error code otherwise */ virtual int PowerOff(void) = 0; /** * @brief Get ID of pressure sensor * @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; /** * @brief Reset sensor - * @retval 0 in case of success, an error code otherwise + * @return 0 in case of success, an error code otherwise */ virtual int Reset(void) = 0; /** * @brief Get current pressure [mbar] * @param[out] pfData Pointer to where to store pressure to - * @retval 0 in case of success, an error code otherwise + * @return 0 in case of success, an error code otherwise */ virtual int GetPressure(float *pfData) = 0;
--- a/Components/Common/TempSensor.h Thu Jun 04 13:46:35 2015 +0200 +++ b/Components/Common/TempSensor.h Thu Jun 04 14:01:31 2015 +0200 @@ -52,33 +52,33 @@ /** * @brief Initialization of temperature sensor * @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 Enter sensor shutdown mode - * @retval 0 in case of success, an error code otherwise + * @return 0 in case of success, an error code otherwise */ virtual int PowerOff(void) = 0; /** * @brief Get ID of temperature sensor * @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; /** * @brief Reset sensor - * @retval 0 in case of success, an error code otherwise + * @return 0 in case of success, an error code otherwise */ virtual int Reset(void) = 0; /** * @brief Get current temperature [°C] * @param[out] pfData Pointer to where to store temperature to - * @retval 0 in case of success, an error code otherwise + * @return 0 in case of success, an error code otherwise */ virtual int GetTemperature(float *pfData) = 0;