Skip to content

Commit 1b97f4b

Browse files
committed
include: usbc: doc: Group all USB-C API in same doxygen Group
Put every header defined in include/zephyr/drivers/usb_c/ into the same doxygroup (`usb_type_c`) so as to not clutter the top-level `io_interfaces` group with multiple USB-C related groups. Signed-off-by: Benjamin Cabé <[email protected]>
1 parent e1f7569 commit 1b97f4b

File tree

4 files changed

+14
-3
lines changed

4 files changed

+14
-3
lines changed

include/zephyr/drivers/usb_c/usbc_pd.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
/**
1818
* @brief USB Power Delivery
1919
* @defgroup usb_power_delivery USB Power Delivery
20-
* @ingroup io_interfaces
20+
* @ingroup usb_type_c
2121
* @{
2222
*/
2323

include/zephyr/drivers/usb_c/usbc_ppc.h

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,13 @@
1212
#ifndef ZEPHYR_INCLUDE_DRIVERS_USBC_USBC_PPC_H_
1313
#define ZEPHYR_INCLUDE_DRIVERS_USBC_USBC_PPC_H_
1414

15+
/**
16+
* @brief USB Type-C Power Path Controller
17+
* @defgroup usb_type_c_power_path_controller USB Type-C Power Path Controller
18+
* @ingroup usb_type_c
19+
* @{
20+
*/
21+
1522
#include <zephyr/types.h>
1623
#include <zephyr/device.h>
1724
#include <errno.h>
@@ -274,4 +281,8 @@ static inline int ppc_dump_regs(const struct device *dev)
274281
}
275282
#endif
276283

284+
/**
285+
* @}
286+
*/
287+
277288
#endif /* ZEPHYR_INCLUDE_DRIVERS_USBC_USBC_PPC_H_ */

include/zephyr/drivers/usb_c/usbc_tcpc.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
* @defgroup usb_type_c_port_controller_api USB Type-C Port Controller API
2121
* @since 3.1
2222
* @version 0.1.0
23-
* @ingroup io_interfaces
23+
* @ingroup usb_type_c
2424
* @{
2525
*/
2626

include/zephyr/drivers/usb_c/usbc_vbus.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
* @defgroup usbc_vbus_api USB-C VBUS API
2121
* @since 3.3
2222
* @version 0.1.0
23-
* @ingroup io_interfaces
23+
* @ingroup usb_type_c
2424
* @{
2525
*/
2626

0 commit comments

Comments
 (0)