From cf60e374aa60507457a193bf12385f9e0f41f035 Mon Sep 17 00:00:00 2001 From: hathach Date: Sun, 23 Mar 2014 19:00:54 +0700 Subject: doxygen clean up --- tinyusb/common/std_request.h | 14 +++++--------- tinyusb/common/tusb_types.h | 5 ++--- tinyusb/doxygen/configuration.h | 4 +++- tinyusb/osal/osal.h | 3 +-- 4 files changed, 11 insertions(+), 15 deletions(-) (limited to 'tinyusb') diff --git a/tinyusb/common/std_request.h b/tinyusb/common/std_request.h index dd48b737c..0ace160c4 100644 --- a/tinyusb/common/std_request.h +++ b/tinyusb/common/std_request.h @@ -36,12 +36,8 @@ */ /**************************************************************************/ -/** \ingroup TBD - * \defgroup TBD - * \brief TBD - * - * @{ - */ +/** \ingroup group_usb_definitions + * @{ */ #ifndef _TUSB_STD_REQUEST_H_ #define _TUSB_STD_REQUEST_H_ @@ -53,9 +49,9 @@ typedef ATTR_PACKED_STRUCT(struct){ union { ATTR_PACKED_STRUCT(struct) { - uint8_t recipient : 5; /**< Recipient type tusb_std_request_recipient_t. */ - uint8_t type : 2; /**< Request type tusb_control_request_type_t. */ - uint8_t direction : 1; /**< Direction type. tusb_direction_t */ + uint8_t recipient : 5; ///< Recipient type tusb_std_request_recipient_t. + uint8_t type : 2; ///< Request type tusb_control_request_type_t. + uint8_t direction : 1; ///< Direction type. tusb_direction_t } bmRequestType_bit; uint8_t bmRequestType; }; diff --git a/tinyusb/common/tusb_types.h b/tinyusb/common/tusb_types.h index 21738fce9..724b4dbd3 100644 --- a/tinyusb/common/tusb_types.h +++ b/tinyusb/common/tusb_types.h @@ -38,8 +38,7 @@ /** \ingroup group_usb_definitions * \defgroup USBDef_Type USB Types - * @{ - */ + * @{ */ #ifndef _TUSB_TUSB_TYPES_H_ #define _TUSB_TUSB_TYPES_H_ @@ -161,7 +160,7 @@ enum { #define TUSB_DESC_CONFIG_POWER_MA(x) ((x)/2) /// Device State -typedef enum tusb_device_state_{ +typedef enum { TUSB_DEVICE_STATE_UNPLUG = 0 , TUSB_DEVICE_STATE_ADDRESSED , TUSB_DEVICE_STATE_CONFIGURED , diff --git a/tinyusb/doxygen/configuration.h b/tinyusb/doxygen/configuration.h index e35dbbe30..33a31479f 100644 --- a/tinyusb/doxygen/configuration.h +++ b/tinyusb/doxygen/configuration.h @@ -21,6 +21,7 @@ #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_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. //--------------------------------------------------------------------+ // HOST CONFIGURATION @@ -55,9 +56,10 @@ // DEVICE CONFIGURATION //--------------------------------------------------------------------+ /** \defgroup TUSB_CFG_DEVICE Device Options - * \brief For each Class Driver a value of 1 means enable, value of 0 mean disable * @{ */ +#define TUSB_CFG_DEVICE_CONTROL_ENDOINT_SIZE ///< Max packet size of Cotnrol Endpoint, default is 64 + /** \defgroup config_device_class Class Driver * \brief For each Class Driver a value of 1 means enable, value of 0 mean disable * @{ */ diff --git a/tinyusb/osal/osal.h b/tinyusb/osal/osal.h index d5faba68e..dd39da281 100644 --- a/tinyusb/osal/osal.h +++ b/tinyusb/osal/osal.h @@ -46,8 +46,7 @@ #define TUSB_OS_NONE 1 ///< No RTOS is used #define TUSB_OS_FREERTOS 2 ///< FreeRTOS is used #define TUSB_OS_CMSIS_RTX 3 ///< CMSIS RTX is used -#define TUSB_OS_UCOS2 4 ///< MicroC OS II is used (not supported yet) -#define TUSB_OS_UCOS3 5 ///< MicroC OS III is used (not supported yet) +#define TUSB_OS_UCOS3 4 ///< MicroC OS III is used (not supported yet) /** @} */ -- cgit v1.3.1