usb: create top-level usb Doxygen group

Create a USB Doxygen group, part of the top-level connectivity group. Added some existing groups to the usb group, note that USB Doxygen needs to be improved, though. Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
Willmish · Jun 6, 2023 · 30946d4 · 30946d4
1 parent 9a806e9
commit 30946d4
Show file tree

Hide file tree

Showing 6 changed files with 26 additions and 20 deletions.
diff --git a/doc/_doxygen/groups.dox b/doc/_doxygen/groups.dox
@@ -24,6 +24,12 @@
 @brief Connectivity
 @defgroup connectivity Connectivity
 @{
+
+@brief USB
+@defgroup usb USB
+@{
+@}
+
 @}
 
 */
diff --git a/doc/services/usb/hid.rst b/doc/services/usb/hid.rst
@@ -40,11 +40,6 @@ HID items reference
 
 .. doxygengroup:: usb_hid_items
 
-HID types reference
-*******************
-
-.. doxygengroup:: usb_hid_types
-
 HID Mouse and Keyboard report descriptors
 *****************************************
 

diff --git a/include/zephyr/usb/class/hid.h b/include/zephyr/usb/class/hid.h
@@ -23,13 +23,12 @@ extern "C" {
 /**
  * @brief hid.h API
  * @defgroup usb_hid_definitions USB HID common definitions
+ * @ingroup usb
  * @{
- * @}
  */
 
 /**
- * @defgroup usb_hid_types USB HID types and values
- * @ingroup usb_hid_definitions
+ * @name USB HID types and values
  * @{
  */
 
@@ -168,7 +167,6 @@ extern "C" {
 
 /**
  * @defgroup usb_hid_items USB HID Item helpers
- * @ingroup usb_hid_definitions
  * @{
  */
 
@@ -419,7 +417,6 @@ extern "C" {
 
 /**
  * @defgroup usb_hid_mk_report_desc Mouse and keyboard report descriptors
- * @ingroup usb_hid_definitions
  * @{
  */
 
@@ -640,6 +637,10 @@ enum hid_kbd_led {
 	HID_KBD_LED_KANA	= 0x10,
 };
 
+/**
+ * @}
+ */
+
 /**
  * @}
  */

diff --git a/include/zephyr/usb/class/usb_hid.h b/include/zephyr/usb/class/usb_hid.h
@@ -22,13 +22,12 @@ extern "C" {
 /**
  * @brief usb_hid.h API
  * @defgroup usb_hid_class USB HID class API
+ * @ingroup usb
  * @{
- * @}
  */
 
 /**
  * @defgroup usb_hid_device_api HID class USB specific definitions
- * @ingroup usb_hid_class
  * @{
  */
 
@@ -125,6 +124,10 @@ int usb_hid_set_proto_code(const struct device *dev, uint8_t proto_code);
  */
 int usb_hid_init(const struct device *dev);
 
+/**
+ * @}
+ */
+
 /**
  * @}
  */

diff --git a/include/zephyr/usb/usbd.h b/include/zephyr/usb/usbd.h
@@ -26,6 +26,13 @@
 extern "C" {
 #endif
 
+/**
+ * @brief New USB device stack core API
+ * @defgroup usbd_api USB device core API
+ * @ingroup usb
+ * @{
+ */
+
 /*
  * The USB Unicode bString is encoded in UTF16LE, which means it takes up
  * twice the amount of bytes than the same string encoded in ASCII7.
@@ -271,13 +278,6 @@ struct usbd_class_node {
 	struct usbd_class_data *data;
 };
 
-/**
- * @brief New USB device stack core API
- * @defgroup usbd_api USB device core API
- * @ingroup usb
- * @{
- */
-
 #define USBD_DEVICE_DEFINE(device_name, uhc_dev, vid, pid)		\
 	static struct usb_device_descriptor				\
 	desc_##device_name = {						\

diff --git a/include/zephyr/usb/usbh.h b/include/zephyr/usb/usbh.h
@@ -27,7 +27,8 @@ extern "C" {
 
 /**
  * @brief USB HOST Core Layer API
- * @defgroup _usb_host_core_api USB Host Core API
+ * @defgroup usb_host_core_api USB Host Core API
+ * @ingroup usb
  * @{
  */