Skip to content

Commit 0f7b103

Browse files
kartbencfriedt
authored andcommitted
include: sensing: doc: sensor types doxygen fixes
add missing docs, group types using `@name` Signed-off-by: Benjamin Cabé <[email protected]>
1 parent 5aa8955 commit 0f7b103

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
@@ -20,35 +20,50 @@
2020
*/
2121

2222
/**
23-
* sensor category light
23+
* @name Light sensors
24+
* @{
2425
*/
26+
27+
/** Sensor type for ambient light sensors. */
2528
#define SENSING_SENSOR_TYPE_LIGHT_AMBIENTLIGHT 0x41
2629

30+
/** @} */
31+
2732
/**
28-
* sensor category motion
33+
* @name Motion sensors
34+
* @{
2935
*/
30-
/* Sensor type for 3D accelerometers. */
36+
37+
/** Sensor type for 3D accelerometers. */
3138
#define SENSING_SENSOR_TYPE_MOTION_ACCELEROMETER_3D 0x73
32-
/* Sensor type for 3D gyrometers. */
39+
/** Sensor type for 3D gyrometers. */
3340
#define SENSING_SENSOR_TYPE_MOTION_GYROMETER_3D 0x76
34-
/* Sensor type for motion detectors. */
41+
/** Sensor type for motion detectors. */
3542
#define SENSING_SENSOR_TYPE_MOTION_MOTION_DETECTOR 0x77
43+
/** Sensor type for uncalibrated 3D accelerometers. */
44+
#define SENSING_SENSOR_TYPE_MOTION_UNCALIB_ACCELEROMETER_3D 0x240
45+
/** Sensor type for hinge angle sensors. */
46+
#define SENSING_SENSOR_TYPE_MOTION_HINGE_ANGLE 0x20B
3647

48+
/** @} */
3749

3850
/**
39-
* sensor category other
51+
* @name Other sensors
52+
* @{
4053
*/
41-
#define SENSING_SENSOR_TYPE_OTHER_CUSTOM 0xE1
4254

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

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

0 commit comments

Comments
 (0)