Skip to content

Commit 3e9f46c

Browse files
kartbennashif
authored andcommitted
doc: doxygen: improve name/desc of Device Drivers group
add an actual meaningful brief and detailed desc Signed-off-by: Benjamin Cabé <[email protected]>
1 parent 08e41ca commit 3e9f46c

File tree

3 files changed

+19
-11
lines changed

3 files changed

+19
-11
lines changed

doc/_doxygen/groups.dox

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,16 @@
1111
@{
1212
@}
1313

14-
@brief Device Driver APIs
15-
@defgroup io_interfaces Device Driver APIs
14+
@defgroup io_interfaces Device Drivers
15+
@brief Interfaces to interact with various hardware peripherals.
16+
@details A collection of hardware-agnostic interfaces used to implement and interact with device
17+
drivers.
1618
@{
1719
@}
1820

19-
@brief Miscellaneous Drivers APIs
20-
@defgroup misc_interfaces Miscellaneous Drivers APIs
21+
@defgroup misc_interfaces Miscellaneous Devices
2122
@ingroup io_interfaces
23+
@brief Interfaces for hardware peripherals that do not have a dedicated driver class.
2224
@{
2325
@}
2426

@@ -28,8 +30,8 @@
2830
@{
2931
@}
3032

31-
@brief Multi Function Device Drivers APIs
32-
@defgroup mfd_interfaces Multi Function Device Drivers APIs
33+
@brief Interfaces for multi-function devices.
34+
@defgroup mfd_interfaces Multi-function Devices
3335
@ingroup io_interfaces
3436
@{
3537
@}

include/zephyr/drivers/pcie/controller.h

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,9 @@
2121
#endif
2222

2323
/**
24-
* @brief PCI Express Controller Interface
25-
* @defgroup pcie_controller_interface PCI Express Controller Interface
26-
* @ingroup io_interfaces
24+
* @brief Interfaces for PCIe Controllers.
25+
* @defgroup pcie_controller_interface PCIe Controller
26+
* @ingroup pcie_interface
2727
* @{
2828
*/
2929

include/zephyr/drivers/pcie/pcie.h

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,16 @@
88
#define ZEPHYR_INCLUDE_DRIVERS_PCIE_PCIE_H_
99

1010
/**
11-
* @brief PCIe Host Interface
12-
* @defgroup pcie_host_interface PCIe Host Interface
11+
* @brief Interfaces for PCIe devices.
12+
* @defgroup pcie_interface PCIe
1313
* @ingroup io_interfaces
1414
* @{
15+
* @}
16+
*
17+
* @brief Interfaces for PCIe Host.
18+
* @defgroup pcie_host_interface PCIe Host
19+
* @ingroup pcie_interface
20+
* @{
1521
*/
1622

1723
#include <stddef.h>

0 commit comments

Comments
 (0)