Skip to content

Commit 8de9e05

Browse files
committed
include: drivers: input: add @file tag to analog_axis headers
This helps anchoring the file to the proper section in the online documentation when browsing by file. Signed-off-by: Benjamin Cabé <[email protected]>
1 parent b1358ef commit 8de9e05

File tree

2 files changed

+18
-6
lines changed

2 files changed

+18
-6
lines changed

include/zephyr/input/input_analog_axis.h

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,24 +4,29 @@
44
* SPDX-License-Identifier: Apache-2.0
55
*/
66

7+
/**
8+
* @file
9+
* @ingroup input_analog_axis
10+
* @brief Main header file for interacting with analog axis input devices.
11+
*/
12+
713
#ifndef ZEPHYR_INCLUDE_INPUT_ANALOG_AXIS_H_
814
#define ZEPHYR_INCLUDE_INPUT_ANALOG_AXIS_H_
915

1016
#include <stdint.h>
1117
#include <zephyr/device.h>
1218

1319
/**
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
1722
* @{
1823
*/
1924

2025
/**
2126
* @brief Analog axis calibration data structure.
2227
*
2328
* 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
2530
* @ref analog_axis_calibration_set and @ref analog_axis_calibration_get.
2631
*/
2732
struct analog_axis_calibration {
@@ -51,13 +56,14 @@ typedef void (*analog_axis_raw_data_t)(const struct device *dev,
5156
* calibration. Set cb to NULL to disable the callback.
5257
*
5358
* @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.
5560
*/
5661
void analog_axis_set_raw_data_cb(const struct device *dev, analog_axis_raw_data_t cb);
5762

5863
/**
5964
* @brief Get the number of defined axes.
6065
*
66+
* @param dev Analog axis device.
6167
* @retval n The number of defined axes for dev.
6268
*/
6369
int analog_axis_num_axes(const struct device *dev);

include/zephyr/input/input_analog_axis_settings.h

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,12 @@
44
* SPDX-License-Identifier: Apache-2.0
55
*/
66

7+
/**
8+
* @file
9+
* @brief Public header file for API allowing to save analog axis calibration data.
10+
* @ingroup input_analog_axis
11+
*/
12+
713
#ifndef ZEPHYR_INCLUDE_INPUT_ANALOG_AXIS_SETTINGS_H_
814
#define ZEPHYR_INCLUDE_INPUT_ANALOG_AXIS_SETTINGS_H_
915

@@ -18,7 +24,7 @@
1824
/**
1925
* @brief Save the calibration data.
2026
*
21-
* Save the calibration data permanently on the specifided device, requires
27+
* Save the calibration data permanently on the specified device, requires
2228
* the @ref settings subsystem to be configured and initialized.
2329
*
2430
* @param dev Analog axis device.

0 commit comments

Comments
 (0)