Skip to content

Commit 86e170a

Browse files
committed
include: drivers: sensor: enhance Doxygen documentation for INA2xx
Complete the Doxygen documentation for this sensor driver, put in sensor_interface_ext group. Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
1 parent ad056d5 commit 86e170a

1 file changed

Lines changed: 18 additions & 0 deletions

File tree

include/zephyr/drivers/sensor/ina2xx.h

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,22 @@
44
* SPDX-License-Identifier: Apache-2.0
55
*/
66

7+
/**
8+
* @file
9+
* @brief Extended public API for the INA2xx family of current/power monitors.
10+
* @ingroup ina2xx_interface
11+
*/
12+
713
#ifndef ZEPHYR_INCLUDE_DRIVERS_SENSOR_INA2XX_H_
814
#define ZEPHYR_INCLUDE_DRIVERS_SENSOR_INA2XX_H_
915

16+
/**
17+
* @brief TI INA2xx current/power monitor family
18+
* @defgroup ina2xx_interface INA2XX
19+
* @ingroup sensor_interface_ext
20+
* @{
21+
*/
22+
1023
#include <zephyr/drivers/sensor.h>
1124

1225
#ifdef __cplusplus
@@ -24,6 +37,7 @@ enum sensor_channel_ina2xx {
2437
SENSOR_CHAN_INA2XX_CHARGE,
2538
};
2639

40+
/** @brief Extended sensor attributes for the INA2xx family. */
2741
enum sensor_attribute_ina2xx {
2842
/** ADC configuration **/
2943
SENSOR_ATTR_ADC_CONFIGURATION = SENSOR_ATTR_PRIV_START,
@@ -33,4 +47,8 @@ enum sensor_attribute_ina2xx {
3347
}
3448
#endif
3549

50+
/**
51+
* @}
52+
*/
53+
3654
#endif /* ZEPHYR_INCLUDE_DRIVERS_SENSOR_INA2XX_H_ */

0 commit comments

Comments
 (0)