Skip to content

Commit 66cbd24

Browse files
committed
driver: use retval to avoid multiple return in doc
1 parent 8d07b22 commit 66cbd24

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

drivers/include/ads1115.h

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -168,9 +168,9 @@ typedef struct {
168168
* @param[in,out] dev Device descriptor
169169
* @param[in] params Device configuration parameters
170170
*
171-
* @return ADS1115_OK on success
172-
* @return ADS1115_NODEV if no device is found on the bus
173-
* @return ADS1115_NOI2C if other error occurs
171+
* @retval ADS1115_OK on success
172+
* @retval ADS1115_NODEV if no device is found on the bus
173+
* @retval ADS1115_NOI2C if other error occurs
174174
*/
175175
int ads1115_init(ads1115_t *dev, const ads1115_params_t *params);
176176

@@ -180,19 +180,19 @@ int ads1115_init(ads1115_t *dev, const ads1115_params_t *params);
180180
* @param[in,out] dev Device descriptor
181181
* @param[in] mux Input multiplexer configuration
182182
*
183-
* @return ADS1115_OK on success
184-
* @return ADS1115_NODEV if no device is found on the bus
185-
* @return ADS1115_NOI2C if other error occurs
183+
* @retval ADS1115_OK on success
184+
* @retval ADS1115_NODEV if no device is found on the bus
185+
* @retval ADS1115_NOI2C if other error occurs
186186
*/
187187
int ads1115_set_ain_ch_input(ads1115_t *dev, ads1115_mux_t mux);
188188

189189
/**
190190
* @brief Read the conversion register of the ADS1115 device.
191191
* @param[in,out] dev Device descriptor
192192
* @param[out] value Pointer to store the conversion result
193-
* @return ADS1115_OK on success
194-
* @return ADS1115_NODATA if no data is available
195-
* @return ADS1115_NOI2C if other error occurs
193+
* @retval ADS1115_OK on success
194+
* @retval ADS1115_NODATA if no data is available
195+
* @retval ADS1115_NOI2C if other error occurs
196196
*/
197197
int ads1115_read_conversion(ads1115_t *dev, uint16_t *value);
198198

0 commit comments

Comments
 (0)