|
4 | 4 | * SPDX-License-Identifier: Apache-2.0
|
5 | 5 | */
|
6 | 6 |
|
| 7 | +/** |
| 8 | + * @file |
| 9 | + * @ingroup input_analog_axis |
| 10 | + * @brief Main header file for interacting with analog axis input devices. |
| 11 | + */ |
| 12 | + |
7 | 13 | #ifndef ZEPHYR_INCLUDE_INPUT_ANALOG_AXIS_H_
|
8 | 14 | #define ZEPHYR_INCLUDE_INPUT_ANALOG_AXIS_H_
|
9 | 15 |
|
10 | 16 | #include <stdint.h>
|
11 | 17 | #include <zephyr/device.h>
|
12 | 18 |
|
13 | 19 | /**
|
14 |
| - * @brief Analog axis API |
15 |
| - * @defgroup input_analog_axis Analog axis API |
16 |
| - * @ingroup io_interfaces |
| 20 | + * @defgroup input_analog_axis Analog axis |
| 21 | + * @ingroup input_interface |
17 | 22 | * @{
|
18 | 23 | */
|
19 | 24 |
|
20 | 25 | /**
|
21 | 26 | * @brief Analog axis calibration data structure.
|
22 | 27 | *
|
23 | 28 | * Holds the calibration data for a single analog axis. Initial values are set
|
24 |
| - * from the devicetree and can be changed by the applicatoin in runtime using |
| 29 | + * from the devicetree and can be changed by the application in runtime using |
25 | 30 | * @ref analog_axis_calibration_set and @ref analog_axis_calibration_get.
|
26 | 31 | */
|
27 | 32 | struct analog_axis_calibration {
|
@@ -51,13 +56,14 @@ typedef void (*analog_axis_raw_data_t)(const struct device *dev,
|
51 | 56 | * calibration. Set cb to NULL to disable the callback.
|
52 | 57 | *
|
53 | 58 | * @param dev Analog axis device.
|
54 |
| - * @param cb An analog_axis_raw_data_t callback to use, NULL disable. |
| 59 | + * @param cb An analog_axis_raw_data_t callback to use, NULL to disable. |
55 | 60 | */
|
56 | 61 | void analog_axis_set_raw_data_cb(const struct device *dev, analog_axis_raw_data_t cb);
|
57 | 62 |
|
58 | 63 | /**
|
59 | 64 | * @brief Get the number of defined axes.
|
60 | 65 | *
|
| 66 | + * @param dev Analog axis device. |
61 | 67 | * @retval n The number of defined axes for dev.
|
62 | 68 | */
|
63 | 69 | int analog_axis_num_axes(const struct device *dev);
|
|
0 commit comments