andy/tinyUSB
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

doxygening

Browse Source
This commit is contained in:
hathach
2014-03-17 16:46:11 +07:00
parent d1d4ddd856
commit eaf2e888ab
9 changed files with 98 additions and 85 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
tinyusb/class/cdc.h
View File

@@ -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
/** @} */
/** @} */

26
tinyusb/class/cdc_host.h
View File

@@ -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_ */
/** @} */

6
tinyusb/class/cdc_rndis.h
View File

@@ -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_