Skip to content

Commit afc739e

Browse files
committed
include: sensing: doc: sensor types doxygen fixes
add missing docs, group types using `@name` Signed-off-by: Benjamin Cabé <[email protected]>
1 parent 45c1281 commit afc739e

File tree

1 file changed

+26
-11
lines changed

1 file changed

+26
-11
lines changed

include/zephyr/sensing/sensing_sensor_types.h

Lines changed: 26 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -21,35 +21,50 @@
2121
*/
2222

2323
/**
24-
* sensor category light
24+
* @name Light sensors
25+
* @{
2526
*/
27+
28+
/** Sensor type for ambient light sensors. */
2629
#define SENSING_SENSOR_TYPE_LIGHT_AMBIENTLIGHT 0x41
2730

31+
/** @} */
32+
2833
/**
29-
* sensor category motion
34+
* @name Motion sensors
35+
* @{
3036
*/
31-
/* Sensor type for 3D accelerometers. */
37+
38+
/** Sensor type for 3D accelerometers. */
3239
#define SENSING_SENSOR_TYPE_MOTION_ACCELEROMETER_3D 0x73
33-
/* Sensor type for 3D gyrometers. */
40+
/** Sensor type for 3D gyrometers. */
3441
#define SENSING_SENSOR_TYPE_MOTION_GYROMETER_3D 0x76
35-
/* Sensor type for motion detectors. */
42+
/** Sensor type for motion detectors. */
3643
#define SENSING_SENSOR_TYPE_MOTION_MOTION_DETECTOR 0x77
44+
/** Sensor type for uncalibrated 3D accelerometers. */
45+
#define SENSING_SENSOR_TYPE_MOTION_UNCALIB_ACCELEROMETER_3D 0x240
46+
/** Sensor type for hinge angle sensors. */
47+
#define SENSING_SENSOR_TYPE_MOTION_HINGE_ANGLE 0x20B
3748

49+
/** @} */
3850

3951
/**
40-
* sensor category other
52+
* @name Other sensors
53+
* @{
4154
*/
42-
#define SENSING_SENSOR_TYPE_OTHER_CUSTOM 0xE1
4355

44-
/* Sensor type for uncalibrated 3D accelerometers. */
45-
#define SENSING_SENSOR_TYPE_MOTION_UNCALIB_ACCELEROMETER_3D 0x240
46-
/* Sensor type for hinge angle sensors. */
47-
#define SENSING_SENSOR_TYPE_MOTION_HINGE_ANGLE 0x20B
56+
/** Sensor type for custom sensors. */
57+
#define SENSING_SENSOR_TYPE_OTHER_CUSTOM 0xE1
58+
59+
/** @} */
4860

4961
/**
5062
* @brief Sensor type for all sensors.
5163
*
5264
* This macro defines the sensor type for all sensors.
65+
*
66+
* @note This value is not a valid sensor type and is used as a sentinel value to indicate all
67+
* sensor types.
5368
*/
5469
#define SENSING_SENSOR_TYPE_ALL 0xFFFF
5570

0 commit comments

Comments
 (0)