michaelh/zephyr
1
0
Fork 0
Code Releases Activity

sensor: doc: add missing doc for decode() retvals

Browse source 
Added missing documentaiton for the return values of the decode() API

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
This commit is contained in:
Benjamin Cabé 2023-08-28 12:22:33 +02:00 • committed by Anas Nashif
commit 0bfd20567f
1 changed files with 3 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

4
include/zephyr/drivers/sensor.h
View file

@ -495,7 +495,9 @@ struct sensor_decoder_api {
* @param[out] channels The channels that were decoded
* @param[out] values The scaled data that was decoded
* @param[in] max_count The maximum number of channels to decode.
* @return
* @retval > 0 The number of decoded values
* @retval 0 Nothing else to decode on the @p buffer
* @retval < 0 Error
*/
int (*decode)(const uint8_t *buffer, sensor_frame_iterator_t *fit,
sensor_channel_iterator_t *cit, enum sensor_channel *channels, q31_t *values,