Skip to content

Commit fa201b3

Browse files
kartbennashif
authored andcommitted
include: drivers: doc: uniformize wording of Doxygen groups
Use consistent wording for Doxygen groups of device driver interfaces. Signed-off-by: Benjamin Cabé <[email protected]>
1 parent fbd2e28 commit fa201b3

Some content is hidden

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

77 files changed

+165
-158
lines changed

include/zephyr/drivers/adc.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ extern "C" {
2323
#endif
2424

2525
/**
26-
* @brief ADC driver APIs
27-
* @defgroup adc_interface ADC driver APIs
26+
* @brief Interfaces for Analog-to-Digital Converters (ADC).
27+
* @defgroup adc_interface ADC
2828
* @since 1.0
2929
* @version 1.0.0
3030
* @ingroup io_interfaces

include/zephyr/drivers/auxdisplay.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@
1414
#define ZEPHYR_INCLUDE_DRIVERS_AUXDISPLAY_H_
1515

1616
/**
17-
* @brief Auxiliary (Text) Display Interface
18-
* @defgroup auxdisplay_interface Text Display Interface
17+
* @brief Interfaces for auxiliary (textual/non-graphical) displays.
18+
* @defgroup auxdisplay_interface Auxiliary (Text) Display
1919
* @since 3.4
2020
* @version 0.1.0
2121
* @ingroup io_interfaces

include/zephyr/drivers/bbram.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@
1818
#include <zephyr/device.h>
1919

2020
/**
21-
* @brief BBRAM Interface
22-
* @defgroup bbram_interface BBRAM Interface
21+
* @brief Interfaces for Battery-Backed RAM (BBRAM).
22+
* @defgroup bbram_interface BBRAM
2323
* @ingroup io_interfaces
2424
* @{
2525
*/

include/zephyr/drivers/bluetooth.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@
1616
#define ZEPHYR_INCLUDE_DRIVERS_BLUETOOTH_H_
1717

1818
/**
19-
* @brief Bluetooth HCI APIs
20-
* @defgroup bt_hci_api Bluetooth HCI APIs
19+
* @brief Interfaces for Bluetooth Host Controller Interface (HCI).
20+
* @defgroup bt_hci_api Bluetooth HCI
2121
*
2222
* @since 3.7
2323
* @version 0.2.0

include/zephyr/drivers/cache.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@
1616
#include <stddef.h>
1717

1818
/**
19-
* @brief External Cache Controller Interface
20-
* @defgroup cache_external_interface External Cache Controller Interface
19+
* @brief Interfaces for external cache controllers.
20+
* @defgroup cache_external_interface External Cache Controller
2121
* @ingroup io_interfaces
2222
* @{
2323
*/

include/zephyr/drivers/cellular.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@
1515
#define ZEPHYR_INCLUDE_DRIVERS_CELLULAR_H_
1616

1717
/**
18-
* @brief Cellular interface
19-
* @defgroup cellular_interface Cellular Interface
18+
* @brief Interfaces for cellular modems.
19+
* @defgroup cellular_interface Cellular
2020
* @ingroup io_interfaces
2121
* @{
2222
*/

include/zephyr/drivers/charger.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@
1414
#define ZEPHYR_INCLUDE_DRIVERS_CHARGER_H_
1515

1616
/**
17-
* @brief Charger Interface
18-
* @defgroup charger_interface Charger Interface
17+
* @brief Interfaces for battery chargers.
18+
* @defgroup charger_interface Battery Charger
1919
* @ingroup io_interfaces
2020
* @{
2121
*/

include/zephyr/drivers/clock_control.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@
1616
#define ZEPHYR_INCLUDE_DRIVERS_CLOCK_CONTROL_H_
1717

1818
/**
19-
* @brief Clock Control Interface
20-
* @defgroup clock_control_interface Clock Control Interface
19+
* @brief Interfaces for clock controllers.
20+
* @defgroup clock_control_interface Clock Control
2121
* @since 1.0
2222
* @version 1.0.0
2323
* @ingroup io_interfaces

include/zephyr/drivers/comparator.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@
1414
*/
1515

1616
/**
17-
* @brief Comparator Interface
18-
* @defgroup comparator_interface Comparator Interface
17+
* @brief Interfaces for comparators.
18+
* @defgroup comparator_interface Comparator
1919
* @since 4.0
2020
* @version 0.1.0
2121
* @ingroup io_interfaces

include/zephyr/drivers/coredump.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@ extern "C" {
2121
#endif
2222

2323
/**
24-
* @brief Coredump pseudo-device driver APIs
25-
* @defgroup coredump_device_interface Coredump pseudo-device driver APIs
24+
* @brief Interfaces for coredump pseudo-device.
25+
* @defgroup coredump_device_interface Coredump pseudo-device
2626
* @ingroup io_interfaces
2727
* @{
2828
*/

0 commit comments

Comments
 (0)