Skip to content

Commit 2ed0d0d

Browse files
committed
include: drivers: sensor: enhance Doxygen documentation for FDC2X1X
Complete the Doxygen documentation for this sensor driver, put in sensor_interface_ext group. Signed-off-by: Benjamin Cabé <[email protected]>
1 parent b50c314 commit 2ed0d0d

File tree

1 file changed

+20
-5
lines changed

1 file changed

+20
-5
lines changed

include/zephyr/drivers/sensor/fdc2x1x.h

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,26 +6,37 @@
66

77
/**
88
* @file
9-
* @brief Extended public API for the Texas Instruments FDC2X1X
9+
* @brief Header file for extended sensor API of FDC2X1X sensor
10+
* @ingroup fdc2x1x_interface
1011
*/
1112

1213
#ifndef ZEPHYR_INCLUDE_DRIVERS_SENSOR_FDC2X1X_H_
1314
#define ZEPHYR_INCLUDE_DRIVERS_SENSOR_FDC2X1X_H_
1415

16+
/**
17+
* @brief Texas Instruments FDC2X1X capacitive sensor
18+
* @defgroup fdc2x1x_interface FDC2X1X
19+
* @ingroup sensor_interface_ext
20+
* @{
21+
*/
22+
1523
#ifdef __cplusplus
1624
extern "C" {
1725
#endif
1826

1927
#include <zephyr/drivers/sensor.h>
2028

29+
/**
30+
* Custom sensor channels for FDC2X1X
31+
*/
2132
enum sensor_channel_fdc2x1x {
22-
/** CH0 Capacitance, in Picofarad **/
33+
/** CH0 Capacitance, in picofarad **/
2334
SENSOR_CHAN_FDC2X1X_CAPACITANCE_CH0 = SENSOR_CHAN_PRIV_START,
24-
/** CH1 Capacitance, in Picofarad **/
35+
/** CH1 Capacitance, in picofarad **/
2536
SENSOR_CHAN_FDC2X1X_CAPACITANCE_CH1,
26-
/** CH2 Capacitance, in Picofarad **/
37+
/** CH2 Capacitance, in picofarad **/
2738
SENSOR_CHAN_FDC2X1X_CAPACITANCE_CH2,
28-
/** CH3 Capacitance, in Picofarad **/
39+
/** CH3 Capacitance, in picofarad **/
2940
SENSOR_CHAN_FDC2X1X_CAPACITANCE_CH3,
3041

3142
/** CH0 Frequency, in MHz **/
@@ -42,4 +53,8 @@ enum sensor_channel_fdc2x1x {
4253
}
4354
#endif
4455

56+
/**
57+
* @}
58+
*/
59+
4560
#endif /* ZEPHYR_INCLUDE_DRIVERS_SENSOR_FDC2X1X_ */

0 commit comments

Comments
 (0)