From eaf2e888ab3025b01bf5b8e5b548337dd5bc63ff Mon Sep 17 00:00:00 2001 From: hathach Date: Mon, 17 Mar 2014 16:46:11 +0700 Subject: doxygening --- tinyusb/class/cdc.h | 5 +---- tinyusb/class/cdc_host.h | 26 ++++++++++---------------- tinyusb/class/cdc_rndis.h | 6 +++--- 3 files changed, 14 insertions(+), 23 deletions(-) (limited to 'tinyusb/class') diff --git a/tinyusb/class/cdc.h b/tinyusb/class/cdc.h index 11c989d0d..76ac8a17e 100644 --- a/tinyusb/class/cdc.h +++ b/tinyusb/class/cdc.h @@ -36,9 +36,7 @@ */ /**************************************************************************/ -/** - * \addtogroup ClassDriver Class Driver - * @{ +/** \ingroup ClassDriver Class Driver * \defgroup ClassDriver_CDC Communication Device Class (CDC) * Currently only Abstract Control Model subclass is supported * @{ @@ -396,4 +394,3 @@ STATIC_ASSERT(sizeof(cdc_line_control_state_t) == 2, "size is not correct"); #endif /** @} */ -/** @} */ diff --git a/tinyusb/class/cdc_host.h b/tinyusb/class/cdc_host.h index 91e653d03..183cfd4b8 100644 --- a/tinyusb/class/cdc_host.h +++ b/tinyusb/class/cdc_host.h @@ -48,16 +48,14 @@ extern "C" { #endif -/** \addtogroup ClassDriver_CDC Communication Device Class (CDC) - * @{ */ - //--------------------------------------------------------------------+ -// APPLICATION PUBLIC API +// CDC APPLICATION PUBLIC API //--------------------------------------------------------------------+ -/** \addtogroup CDC_Serial Serial - * @{ - * \defgroup CDC_Serial_Host Host - * @{ */ +/** \ingroup ClassDriver_CDC Communication Device Class (CDC) + * \addtogroup CDC_Serial Serial + * @{ + * \defgroup CDC_Serial_Host Host + * @{ */ /** \brief Check if device support CDC Serial interface or not * \param[in] dev_addr device address @@ -131,15 +129,14 @@ void tusbh_cdc_unmounted_cb(uint8_t dev_addr); */ void tusbh_cdc_xfer_isr(uint8_t dev_addr, tusb_event_t event, cdc_pipeid_t pipe_id, uint32_t xferred_bytes); -/// @} +/// @} // group CDC_Serial_Host /// @} //--------------------------------------------------------------------+ // RNDIS APPLICATION API //--------------------------------------------------------------------+ -/** \addtogroup CDC_RNDIS Remote Network Driver Interface Specification (RNDIS) - * @{ - * \addtogroup CDC_RNSID_Host Host +/** \ingroup CDC_RNDIS Remote Network Driver Interface Specification (RNDIS) + * \defgroup CDC_RNSID_Host Host * @{ */ bool tusbh_cdc_rndis_is_mounted(uint8_t dev_addr) ATTR_PURE ATTR_WARN_UNUSED_RESULT; @@ -162,8 +159,7 @@ void tusbh_cdc_rndis_unmounted_cb(uint8_t dev_addr); void tusbh_cdc_rndis_xfer_isr(uint8_t dev_addr, tusb_event_t event, cdc_pipeid_t pipe_id, uint32_t xferred_bytes); -/// @} -/// @} +/// @} // group CDC_RNSID_Host //--------------------------------------------------------------------+ // USBH-CLASS API @@ -194,5 +190,3 @@ void cdch_close(uint8_t dev_addr); #endif #endif /* _TUSB_CDC_HOST_H_ */ - -/** @} */ diff --git a/tinyusb/class/cdc_rndis.h b/tinyusb/class/cdc_rndis.h index c610e5781..3b4413c27 100644 --- a/tinyusb/class/cdc_rndis.h +++ b/tinyusb/class/cdc_rndis.h @@ -36,11 +36,11 @@ */ /**************************************************************************/ -/** \addtogroup CDC_RNDIS Remote Network Driver Interface Specification (RNDIS) +/** \ingroup ClassDriver_CDC Communication Device Class (CDC) + * \defgroup CDC_RNDIS Remote Network Driver Interface Specification (RNDIS) * @{ * \defgroup CDC_RNDIS_Common Common Definitions - * @{ - */ + * @{ */ #ifndef _TUSB_CDC_RNDIS_H_ #define _TUSB_CDC_RNDIS_H_ -- cgit v1.3.1