From 2c9b1346993fc2293a8c0092980df0d188b2c556 Mon Sep 17 00:00:00 2001 From: hathach Date: Mon, 31 Mar 2014 16:34:23 +0700 Subject: [PATCH] move doxygen folder outside --- .../doxygen => doxygen}/coding_standard.md | 0 .../doxygen => doxygen}/configuration.txt | 156 +++++++++--------- {tinyusb/doxygen => doxygen}/get_started.md | 0 {tinyusb/doxygen => doxygen}/group_def.txt | 0 tinyusb.Doxyfile | 2 +- 5 files changed, 79 insertions(+), 79 deletions(-) rename {tinyusb/doxygen => doxygen}/coding_standard.md (100%) rename {tinyusb/doxygen => doxygen}/configuration.txt (98%) rename {tinyusb/doxygen => doxygen}/get_started.md (100%) rename {tinyusb/doxygen => doxygen}/group_def.txt (100%) diff --git a/tinyusb/doxygen/coding_standard.md b/doxygen/coding_standard.md similarity index 100% rename from tinyusb/doxygen/coding_standard.md rename to doxygen/coding_standard.md diff --git a/tinyusb/doxygen/configuration.txt b/doxygen/configuration.txt similarity index 98% rename from tinyusb/doxygen/configuration.txt rename to doxygen/configuration.txt index d86c4402b..c84eea76e 100644 --- a/tinyusb/doxygen/configuration.txt +++ b/doxygen/configuration.txt @@ -1,78 +1,78 @@ -/** \addtogroup group_configuration - * @{ */ - -//--------------------------------------------------------------------+ -// COMMON CONFIGURATION -//--------------------------------------------------------------------+ - -/// \brief tell the stack which mode (host/device/otg) the usb controller0 will be operated on. Possible value is -/// from \ref group_mode. Note the hardware usb controller must support the selected mode. -#define TUSB_CFG_CONTROLLER_0_MODE - -/** USB controller in MCU often has limited access to specific RAM section. The Stack will use this macro to place internal variables - into the USB RAM section as follows. if your mcu's usb controller has no such limit, define TUSB_CFG_ATTR_USBRAM as empty macro. - - @code - TUSB_CFG_ATTR_USBRAM uint8_t usb_xfer_buffer[10]; - @endcode - */ -#define TUSB_CFG_ATTR_USBRAM - -#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. - -//--------------------------------------------------------------------+ -// HOST CONFIGURATION -//--------------------------------------------------------------------+ -/** \defgroup TUSB_CFG_HOST Host Options - * @{ */ - -/** \brief Maximum number of device host stack can manage - * \n If hub class is not enabled, set this equal to number of controllers in host mode - * \n If hub class is enabled, make sure hub is also counted */ -#define TUSB_CFG_HOST_DEVICE_MAX - -/// \brief Buffer size used for getting device configuration descriptor. You may want to increase this from default (256) -/// to support lengthy composite device especially with Audio or Video class -#define TUSB_CFG_HOST_ENUM_BUFFER_SIZE - -/** \defgroup config_host_class Class Driver - * \brief For each Class Driver a value of 1 means enable, value of 0 mean disable - * @{ */ -#define TUSB_CFG_HOST_HUB ///< Enable Hub Class -#define TUSB_CFG_HOST_HID_KEYBOARD ///< Enable HID Class for Keyboard -#define TUSB_CFG_HOST_HID_MOUSE ///< Enable HID Class for Mouse -#define TUSB_CFG_HOST_HID_GENERIC ///< Enable HID Class for Generic (not supported yet) -#define TUSB_CFG_HOST_MSC ///< Enable Mass Storage Class (SCSI subclass only) -#define TUSB_CFG_HOST_CDC ///< Enable Virtual Serial (Communication Device Class) -/** @} */ - -/** @} */ // group Host - -//--------------------------------------------------------------------+ -// DEVICE CONFIGURATION -//--------------------------------------------------------------------+ -/** \defgroup TUSB_CFG_DEVICE Device Options - * @{ */ - -#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 - * @{ */ -#define TUSB_CFG_DEVICE_HID_KEYBOARD ///< Enable HID Class for Keyboard -#define TUSB_CFG_DEVICE_HID_MOUSE ///< Enable HID Class for Mouse -#define TUSB_CFG_DEVICE_HID_GENERIC ///< Enable HID Class for Generic (not supported yet) -#define TUSB_CFG_DEVICE_MSC ///< Enable Mass Storage Class (SCSI subclass only) -#define TUSB_CFG_DEVICE_CDC ///< Enable Virtual Serial (Communication Device Class) -/** @} */ - -/** @} */ // group Device - -/** @} */ +/** \addtogroup group_configuration + * @{ */ + +//--------------------------------------------------------------------+ +// COMMON CONFIGURATION +//--------------------------------------------------------------------+ + +/// \brief tell the stack which mode (host/device/otg) the usb controller0 will be operated on. Possible value is +/// from \ref group_mode. Note the hardware usb controller must support the selected mode. +#define TUSB_CFG_CONTROLLER_0_MODE + +/** USB controller in MCU often has limited access to specific RAM section. The Stack will use this macro to place internal variables + into the USB RAM section as follows. if your mcu's usb controller has no such limit, define TUSB_CFG_ATTR_USBRAM as empty macro. + + @code + TUSB_CFG_ATTR_USBRAM uint8_t usb_xfer_buffer[10]; + @endcode + */ +#define TUSB_CFG_ATTR_USBRAM + +#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. + +//--------------------------------------------------------------------+ +// HOST CONFIGURATION +//--------------------------------------------------------------------+ +/** \defgroup TUSB_CFG_HOST Host Options + * @{ */ + +/** \brief Maximum number of device host stack can manage + * \n If hub class is not enabled, set this equal to number of controllers in host mode + * \n If hub class is enabled, make sure hub is also counted */ +#define TUSB_CFG_HOST_DEVICE_MAX + +/// \brief Buffer size used for getting device configuration descriptor. You may want to increase this from default (256) +/// to support lengthy composite device especially with Audio or Video class +#define TUSB_CFG_HOST_ENUM_BUFFER_SIZE + +/** \defgroup config_host_class Class Driver + * \brief For each Class Driver a value of 1 means enable, value of 0 mean disable + * @{ */ +#define TUSB_CFG_HOST_HUB ///< Enable Hub Class +#define TUSB_CFG_HOST_HID_KEYBOARD ///< Enable HID Class for Keyboard +#define TUSB_CFG_HOST_HID_MOUSE ///< Enable HID Class for Mouse +#define TUSB_CFG_HOST_HID_GENERIC ///< Enable HID Class for Generic (not supported yet) +#define TUSB_CFG_HOST_MSC ///< Enable Mass Storage Class (SCSI subclass only) +#define TUSB_CFG_HOST_CDC ///< Enable Virtual Serial (Communication Device Class) +/** @} */ + +/** @} */ // group Host + +//--------------------------------------------------------------------+ +// DEVICE CONFIGURATION +//--------------------------------------------------------------------+ +/** \defgroup TUSB_CFG_DEVICE Device Options + * @{ */ + +#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 + * @{ */ +#define TUSB_CFG_DEVICE_HID_KEYBOARD ///< Enable HID Class for Keyboard +#define TUSB_CFG_DEVICE_HID_MOUSE ///< Enable HID Class for Mouse +#define TUSB_CFG_DEVICE_HID_GENERIC ///< Enable HID Class for Generic (not supported yet) +#define TUSB_CFG_DEVICE_MSC ///< Enable Mass Storage Class (SCSI subclass only) +#define TUSB_CFG_DEVICE_CDC ///< Enable Virtual Serial (Communication Device Class) +/** @} */ + +/** @} */ // group Device + +/** @} */ diff --git a/tinyusb/doxygen/get_started.md b/doxygen/get_started.md similarity index 100% rename from tinyusb/doxygen/get_started.md rename to doxygen/get_started.md diff --git a/tinyusb/doxygen/group_def.txt b/doxygen/group_def.txt similarity index 100% rename from tinyusb/doxygen/group_def.txt rename to doxygen/group_def.txt diff --git a/tinyusb.Doxyfile b/tinyusb.Doxyfile index 9180ca172..9fb0c858c 100644 --- a/tinyusb.Doxyfile +++ b/tinyusb.Doxyfile @@ -749,7 +749,7 @@ WARN_LOGFILE = # spaces. # Note: If this tag is empty the current directory is searched. -INPUT = tinyusb/doxygen/group_def.txt \ +INPUT = doxygen \ readme.markdown \ tinyusb \ boards \