some doxygen

This commit is contained in:
hathach 2014-03-21 16:59:34 +07:00
parent 08dd42fa5c
commit b349121c09
2 changed files with 8 additions and 7 deletions

View File

@ -42,8 +42,7 @@
/** \addtogroup group_usb_definitions USB Definitions /** \addtogroup group_usb_definitions USB Definitions
* @{ * @{
* \defgroup Group_StdDescriptor Standard Descriptors * \defgroup Group_StdDescriptor Standard Descriptors
* @{ * @{ */
*/
#ifndef _TUSB_STD_DESCRIPTORS_H_ #ifndef _TUSB_STD_DESCRIPTORS_H_
#define _TUSB_STD_DESCRIPTORS_H_ #define _TUSB_STD_DESCRIPTORS_H_

View File

@ -63,13 +63,15 @@
#define ATTR_USB_MIN_ALIGNMENT #define ATTR_USB_MIN_ALIGNMENT
#endif #endif
/// \brief Descriptor pointer collector to all the needed. All the addresses pointed
/// must be accessible by USB controller (see \ref TUSB_CFG_ATTR_USBRAM)
typedef struct { typedef struct {
uint8_t * p_device; uint8_t * p_device; ///< pointer to device descritpor \ref tusb_descriptor_device_t
uint8_t * p_configuration; uint8_t * p_configuration; ///< pointer to the whole configuration descriptor, starting by \ref tusb_descriptor_configuration_t
uint8_t * p_string_arr[TUSB_CFG_DEVICE_STRING_DESCRIPTOR_COUNT]; uint8_t * p_string_arr[TUSB_CFG_DEVICE_STRING_DESCRIPTOR_COUNT]; ///< a array of pointers to string descriptors
uint8_t * p_hid_keyboard_report; uint8_t * p_hid_keyboard_report; ///< pointer to HID report descriptor of Keybaord interface. Only needed if TUSB_CFG_DEVICE_HID_KEYBOARD is enabled
uint8_t * p_hid_mouse_report; uint8_t * p_hid_mouse_report; ///< pointer to HID report descriptor of Mouse interface. Only needed if TUSB_CFG_DEVICE_HID_MOUSE is enabled
}tusbd_descriptor_pointer_t; }tusbd_descriptor_pointer_t;
// define by application // define by application