Skip to content

Commit c62985f

Browse files
committed
doc: usb: re-organize doxygen groups for usb hardware
USB host, device, Type-C, and BC1.2 are now all grouped under a top-level USB entry in the "Device drivers" doxygen group. Signed-off-by: Benjamin Cabé <[email protected]>
1 parent e7709ec commit c62985f

File tree

5 files changed

+15
-9
lines changed

5 files changed

+15
-9
lines changed

doc/_doxygen/groups.dox

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,12 @@
2222
@{
2323
@}
2424

25+
@brief Interfaces for USB hardware and associated standards.
26+
@defgroup usb_interfaces USB
27+
@ingroup io_interfaces
28+
@{
29+
@}
30+
2531
@brief Multi Function Device Drivers APIs
2632
@defgroup mfd_interfaces Multi Function Device Drivers APIs
2733
@ingroup io_interfaces

include/zephyr/drivers/usb/udc.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -295,8 +295,8 @@ struct udc_data {
295295

296296
/**
297297
* @brief New USB device controller (UDC) driver API
298-
* @defgroup udc_api USB device controller driver API
299-
* @ingroup io_interfaces
298+
* @defgroup udc_api USB Device Controller
299+
* @ingroup usb_interfaces
300300
* @since 3.3
301301
* @version 0.1.0
302302
* @{

include/zephyr/drivers/usb/uhc.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@
2020

2121
/**
2222
* @brief USB host controller (UHC) driver API
23-
* @defgroup uhc_api USB host controller driver API
24-
* @ingroup io_interfaces
23+
* @defgroup uhc_api USB Host Controller
24+
* @ingroup usb_interfaces
2525
* @since 3.3
2626
* @version 0.1.1
2727
* @{

include/zephyr/drivers/usb/usb_bc12.h

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@ extern "C" {
1919
#endif
2020

2121
/**
22-
* @brief BC1.2 driver APIs
23-
* @defgroup b12_interface BC1.2 driver APIs
24-
* @ingroup io_interfaces
22+
* @brief USB Battery Charging (BC1.2) driver APIs
23+
* @defgroup b12_interface Battery Charging (BC1.2)
24+
* @ingroup usb_interfaces
2525
* @{
2626
*/
2727

include/zephyr/drivers/usb_c/usbc_tc.h

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

1717
/**
18-
* @brief USB Type-C
18+
* @brief Support for USB Type-C cables and connectors
1919
* @defgroup usb_type_c USB Type-C
20-
* @ingroup io_interfaces
20+
* @ingroup usb_interfaces
2121
* @{
2222
*/
2323

0 commit comments

Comments
 (0)