Skip to content

Commit fbd2e28

Browse files
kartbennashif
authored andcommitted
include: drivers: add Doxygen @file tag
Ensure all top-level device driver headers have a Doxygen @file tag and put the @file in the same group as the driver API. Signed-off-by: Benjamin Cabé <[email protected]>
1 parent 3e9f46c commit fbd2e28

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

66 files changed

+245
-120
lines changed

include/zephyr/drivers/adc.h

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
1-
/**
2-
* @file
3-
* @brief ADC public API header file.
4-
*/
5-
61
/*
72
* Copyright (c) 2018 Nordic Semiconductor ASA
83
* Copyright (c) 2015 Intel Corporation
94
*
105
* SPDX-License-Identifier: Apache-2.0
116
*/
127

8+
/**
9+
* @file
10+
* @ingroup adc_interface
11+
* @brief Main header file for ADC (Analog-to-Digital Converter) driver API.
12+
*/
13+
1314
#ifndef ZEPHYR_INCLUDE_DRIVERS_ADC_H_
1415
#define ZEPHYR_INCLUDE_DRIVERS_ADC_H_
1516

include/zephyr/drivers/auxdisplay.h

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@
66

77
/**
88
* @file
9-
* @brief Public API for auxiliary (textual/non-graphical) display drivers
9+
* @ingroup auxdisplay_interface
10+
* @brief Main header file for auxiliary (textual/non-graphical) display driver API.
1011
*/
1112

1213
#ifndef ZEPHYR_INCLUDE_DRIVERS_AUXDISPLAY_H_

include/zephyr/drivers/bbram.h

Lines changed: 6 additions & 0 deletions
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+
* @ingroup bbram_interface
10+
* @brief Main header file for Battery-Backed RAM (BBRAM) driver API.
11+
*/
12+
713
#ifndef ZEPHYR_INCLUDE_DRIVERS_BBRAM_H
814
#define ZEPHYR_INCLUDE_DRIVERS_BBRAM_H
915

include/zephyr/drivers/bluetooth.h

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,13 @@
55
*
66
* SPDX-License-Identifier: Apache-2.0
77
*/
8+
9+
/**
10+
* @file
11+
* @ingroup bt_hci_api
12+
* @brief Main header file for Bluetooth HCI driver API.
13+
*/
14+
815
#ifndef ZEPHYR_INCLUDE_DRIVERS_BLUETOOTH_H_
916
#define ZEPHYR_INCLUDE_DRIVERS_BLUETOOTH_H_
1017

include/zephyr/drivers/cache.h

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@
66

77
/**
88
* @file
9-
* Public APIs for external cache controller drivers
9+
* @ingroup cache_external_interface
10+
* @brief Main header file for external cache controller driver API.
1011
*/
1112

1213
#ifndef ZEPHYR_INCLUDE_DRIVERS_CACHE_H_

include/zephyr/drivers/can.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
/**
1010
* @file
11-
* @brief Main header file for Controller Area Network (CAN) driver API.
11+
* @brief Header file for Controller Area Network (CAN) controller driver API.
1212
* @ingroup can_controller
1313
*/
1414

include/zephyr/drivers/cellular.h

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,9 @@
66
*/
77

88
/**
9-
* @file drivers/cellular.h
10-
* @brief Public cellular network API
9+
* @file
10+
* @ingroup cellular_interface
11+
* @brief Main header file for cellular modem driver API.
1112
*/
1213

1314
#ifndef ZEPHYR_INCLUDE_DRIVERS_CELLULAR_H_

include/zephyr/drivers/charger.h

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@
66

77
/**
88
* @file
9-
* @brief Charger APIs
9+
* @ingroup charger_interface
10+
* @brief Main header file for battery charger driver API.
1011
*/
1112

1213
#ifndef ZEPHYR_INCLUDE_DRIVERS_CHARGER_H_

include/zephyr/drivers/clock_control.h

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@
88

99
/**
1010
* @file
11-
* @brief Public Clock Control APIs
11+
* @ingroup clock_control_interface
12+
* @brief Main header file for clock control driver API.
1213
*/
1314

1415
#ifndef ZEPHYR_INCLUDE_DRIVERS_CLOCK_CONTROL_H_

include/zephyr/drivers/comparator.h

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,12 @@
77
#ifndef ZEPHYR_INCLUDE_DRIVERS_COMPARATOR_H_
88
#define ZEPHYR_INCLUDE_DRIVERS_COMPARATOR_H_
99

10+
/**
11+
* @file
12+
* @ingroup comparator_interface
13+
* @brief Main header file for comparator driver API.
14+
*/
15+
1016
/**
1117
* @brief Comparator Interface
1218
* @defgroup comparator_interface Comparator Interface

0 commit comments

Comments
 (0)