doxygen documenting

This commit is contained in:
hathach
2014-03-25 13:00:37 +07:00
parent 41610af72a
commit 15d0139bc5
30 changed files with 184 additions and 243 deletions

View File

@@ -18,8 +18,8 @@
*/
#define TUSB_CFG_ATTR_USBRAM
#define TUSB_CFG_MCU ///< Select one of the supported MCU, the value must be from \ref config_mcu_selection
#define TUSB_CFG_OS ///< Select one of the supported RTOS, the value must be from \ref TUSB_OS RTOS.
#define TUSB_CFG_MCU ///< Select one of the supported MCU, the value must be from \ref group_mcu
#define TUSB_CFG_OS ///< Select one of the supported RTOS, the value must be from \ref group_supported_os.
#define TUSB_CFG_OS_TASK_PRIO ///< If \ref TUSB_CFG_OS is configured to use a real RTOS (other than TUSB_OS_NONE). This determines the priority of the usb stack task.
#define TUSB_CFG_TICKS_HZ ///< The rate ticks in hert. This is used in conjunction with \ref tusb_tick_get to calculate timing.
@@ -60,6 +60,10 @@
#define TUSB_CFG_DEVICE_CONTROL_ENDOINT_SIZE ///< Max packet size of Cotnrol Endpoint, default is 64
/// Application MUST define this variable and initialize its pointers's member to all required USB descriptors including
/// Device Descriptor, Configuration Descriptor, String Descriptors, HID Report Descriptors etc ...
tusbd_descriptor_pointer_t tusbd_descriptor_pointers;
/** \defgroup config_device_class Class Driver
* \brief For each Class Driver a value of 1 means enable, value of 0 mean disable
* @{ */
@@ -70,6 +74,6 @@
#define TUSB_CFG_DEVICE_CDC ///< Enable Virtual Serial (Communication Device Class)
/** @} */
/** @} */ // group Device
/** @} */ // group Device
/** @} */

View File

@@ -0,0 +1,9 @@
// define all the modules group to have the desired ordering since doxygen order module group by
// the order of files it is feed
/// \defgroup group_class Application - Class Driver API
/// \defgroup group_application_api Application - Stack API
/// \brief Non-Class driver API
/// \defgroup group_configuration Configuration tusb_config.h