more doxygen stuffs

This commit is contained in:
hathach 2014-03-25 13:11:22 +07:00
parent 15d0139bc5
commit 45aef4c04c
7 changed files with 20 additions and 10 deletions

View File

@ -36,7 +36,8 @@
*/ */
/**************************************************************************/ /**************************************************************************/
/** \defgroup group_board Boards Abstraction Layer /** \ingroup group_demo
* \defgroup group_board Boards Abstraction Layer
* @{ */ * @{ */
#ifndef _TUSB_BOARD_H_ #ifndef _TUSB_BOARD_H_

View File

@ -36,8 +36,7 @@
*/ */
/**************************************************************************/ /**************************************************************************/
/** \defgroup Group_Common Common Files /** \ingroup Group_Common
* @{
* \defgroup Group_CommonH common.h * \defgroup Group_CommonH common.h
* @{ */ * @{ */
@ -285,4 +284,3 @@ static inline uint8_t cardinality_of(uint32_t value)
#endif /* _TUSB_COMMON_H_ */ #endif /* _TUSB_COMMON_H_ */
/** @} */ /** @} */
/** @} */

View File

@ -38,8 +38,7 @@
/// \brief Types & Declaration by USB Specs. All documents sources mentioned here (eg section 3.5) is referring to USB 2.0 Specs unless state otherwise /// \brief Types & Declaration by USB Specs. All documents sources mentioned here (eg section 3.5) is referring to USB 2.0 Specs unless state otherwise
/** \addtogroup group_usb_definitions USB Definitions /** \ingroup group_usb_definitions
* @{
* \defgroup Group_StdDescriptor Standard Descriptors * \defgroup Group_StdDescriptor Standard Descriptors
* @{ */ * @{ */
@ -188,4 +187,3 @@ typedef ATTR_PACKED_STRUCT(struct)
#endif /* _TUSB_STD_DESCRIPTORS_H_ */ #endif /* _TUSB_STD_DESCRIPTORS_H_ */
/** @} */ /** @} */
/** @} */

View File

@ -36,7 +36,7 @@
*/ */
/**************************************************************************/ /**************************************************************************/
/** \defgroup group_usbd USB Device Core (USBD) /** \ingroup group_usbd
* @{ */ * @{ */
#ifndef _TUSB_USBD_H_ #ifndef _TUSB_USBD_H_

View File

@ -1,9 +1,22 @@
// define all the modules group to have the desired ordering since doxygen order module group by // define all the modules group to have the desired ordering since doxygen order module group by
// the order of files it is feed // the order of files it is feed
/// \defgroup group_demo Demos
/// \defgroup group_class Application - Class Driver API /// \defgroup group_class Application - Class Driver API
/// \defgroup group_application_api Application - Stack API /// \defgroup group_application_api Application - Stack API
/// \brief Non-Class driver API /// \brief Non-Class driver API
/// \defgroup group_configuration Configuration tusb_config.h /// \defgroup group_configuration Configuration tusb_config.h
/// \defgroup group_usbd USB Device Core (USBD)
/// \defgroup group_usbh USB Host Core (USBH)
/// \defgroup group_osal OS Abstraction Layer (OSAL)
/// \defgroup group_usb_definitions USB Definitions
/// \defgroup Group_Common Common Files

View File

@ -36,7 +36,7 @@
*/ */
/**************************************************************************/ /**************************************************************************/
/** \defgroup group_usbh USB Host Core (USBH) /** \ingroup group_usbh USB Host Core (USBH)
* @{ */ * @{ */
#ifndef _TUSB_USBH_H_ #ifndef _TUSB_USBH_H_

View File

@ -43,7 +43,7 @@
extern "C" { extern "C" {
#endif #endif
/** \defgroup group_osal OS Abstraction Layer (OSAL) /** \addtogroup group_osal
* @{ */ * @{ */
/** \defgroup group_supported_os Supported RTOS /** \defgroup group_supported_os Supported RTOS