Skip to content

Commit b50c314

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

File tree

1 file changed

+21
-1
lines changed

1 file changed

+21
-1
lines changed

include/zephyr/drivers/sensor/pat9136.h

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,32 @@
55
* SPDX-License-Identifier: Apache-2.0
66
*/
77

8+
/**
9+
* @file
10+
* @brief Header file for extended sensor API of PAT9136 sensor
11+
* @ingroup pat9136_interface
12+
*/
13+
814
#ifndef ZEPHYR_INCLUDE_DRIVERS_SENSOR_PAT9136_H_
915
#define ZEPHYR_INCLUDE_DRIVERS_SENSOR_PAT9136_H_
1016

17+
/**
18+
* @brief Pixart PAT9136 optical flow sensor
19+
* @defgroup pat9136_interface PAT9136
20+
* @ingroup sensor_interface_ext
21+
* @{
22+
*/
23+
1124
#include <zephyr/drivers/sensor.h>
1225

1326
#ifdef __cplusplus
1427
extern "C" {
1528
#endif
1629

17-
/** This sensor does have the ability to provide DXY in meaningful units, and
30+
/**
31+
* Custom sensor channels for PAT9136
32+
*
33+
* This sensor does have the ability to provide DXY in meaningful units, and
1834
* since the standard channels' unit is in points (SENSOR_CHAN_POS_DX,
1935
* SENSOR_CHAN_POS_DY, SENSOR_CHAN_POS_DXYZ), we've captured the following
2036
* channels to provide an alternative for this sensor.
@@ -35,4 +51,8 @@ enum sensor_channel_pat9136 {
3551
}
3652
#endif
3753

54+
/**
55+
* @}
56+
*/
57+
3858
#endif /* ZEPHYR_INCLUDE_DRIVERS_SENSOR_PAT9136_H_ */

0 commit comments

Comments
 (0)