Change AVRISP project's timeout to be interrupt based again, but make the interrupt...

[pub/USBasp.git] / LUFA / Drivers / USB / HighLevel / StdDescriptors.h

diff --git a/LUFA/Drivers/USB/HighLevel/StdDescriptors.h b/LUFA/Drivers/USB/HighLevel/StdDescriptors.h
index 27fcfe8..5f54561 100644 (file)
--- a/LUFA/Drivers/USB/HighLevel/StdDescriptors.h
+++ b/LUFA/Drivers/USB/HighLevel/StdDescriptors.h
@@ -211,7 +211,9 @@
                        };\r
 \r
                /* Type Defines: */\r
                        };\r
 \r
                /* Type Defines: */\r

-                       /** Type define for all descriptors standard header, indicating the descriptor's length and type. This structure\r
+                       /** \brief Standard USB Descriptor Header (LUFA naming conventions).\r
+                        *\r
+             *  Type define for all descriptors' standard header, indicating the descriptor's length and type. This structure\r

                         *  uses LUFA-specific element names to make each element's purpose clearer.\r
                         *\r
                         *  \see \ref USB_StdDescriptor_Header_t for the version of this define with standard element names\r
                         *  uses LUFA-specific element names to make each element's purpose clearer.\r
                         *\r
                         *  \see \ref USB_StdDescriptor_Header_t for the version of this define with standard element names\r


@@ -224,7 +226,9 @@
                                                   */\r
                        } USB_Descriptor_Header_t;\r
                        \r
                                                   */\r
                        } USB_Descriptor_Header_t;\r
                        \r

-                       /** Type define for all descriptors standard header, indicating the descriptor's length and type. This structure\r
+                       /** \brief Standard USB Descriptor Header (USB-IF naming conventions).\r
+                        *\r
+                        *  Type define for all descriptors' standard header, indicating the descriptor's length and type. This structure\r

                         *  uses the relevant standard's given element names to ensure compatibility with the standard.\r
                         *\r
                         *  \see \ref USB_Descriptor_Header_t for the version of this define with non-standard LUFA specific element names\r
                         *  uses the relevant standard's given element names to ensure compatibility with the standard.\r
                         *\r
                         *  \see \ref USB_Descriptor_Header_t for the version of this define with non-standard LUFA specific element names\r


@@ -237,7 +241,9 @@
                                                              */\r
                        } USB_StdDescriptor_Header_t;\r
                        \r
                                                              */\r
                        } USB_StdDescriptor_Header_t;\r
                        \r

-                       /** Type define for a standard Device Descriptor. This structure uses LUFA-specific element names to make each\r
+                       /** \brief Standard USB Device Descriptor (LUFA naming conventions).\r
+                        *\r
+                        *  Type define for a standard Device Descriptor. This structure uses LUFA-specific element names to make each\r

                         *  element's purpose clearer.\r
                         *\r
                         *  \see \ref USB_StdDescriptor_Device_t for the version of this define with standard element names\r
                         *  element's purpose clearer.\r
                         *\r
                         *  \see \ref USB_StdDescriptor_Device_t for the version of this define with standard element names\r


@@ -284,7 +290,9 @@
                                                                     */\r
                        } USB_Descriptor_Device_t;\r
 \r
                                                                     */\r
                        } USB_Descriptor_Device_t;\r
 \r

-                       /** Type define for a standard Device Descriptor. This structure uses the relevant standard's given element names\r
+                       /** \brief Standard USB Device Descriptor (USB-IF naming conventions).\r
+                        *\r
+                        *  Type define for a standard Device Descriptor. This structure uses the relevant standard's given element names\r

                         *  to ensure compatibility with the standard.\r
                         *\r
                         *  \see \ref USB_Descriptor_Device_t for the version of this define with non-standard LUFA specific element names\r
                         *  to ensure compatibility with the standard.\r
                         *\r
                         *  \see \ref USB_Descriptor_Device_t for the version of this define with non-standard LUFA specific element names\r


@@ -330,7 +338,9 @@
                                                                 */\r
                        } USB_StdDescriptor_Device_t;\r
 \r
                                                                 */\r
                        } USB_StdDescriptor_Device_t;\r
 \r

-                       /** Type define for a standard Configuration Descriptor header. This structure uses LUFA-specific element names\r
+                       /** \brief Standard USB Configuration Descriptor (LUFA naming conventions).\r
+                        *\r
+                        *  Type define for a standard Configuration Descriptor header. This structure uses LUFA-specific element names\r

                         *  to make each element's purpose clearer.\r
                         *\r
                         *  \see \ref USB_StdDescriptor_Configuration_Header_t for the version of this define with standard element names\r
                         *  to make each element's purpose clearer.\r
                         *\r
                         *  \see \ref USB_StdDescriptor_Configuration_Header_t for the version of this define with standard element names\r


@@ -357,7 +367,9 @@
                                                                  */\r
                        } USB_Descriptor_Configuration_Header_t;\r
                        \r
                                                                  */\r
                        } USB_Descriptor_Configuration_Header_t;\r
                        \r

-                       /** Type define for a standard Configuration Descriptor header. This structure uses the relevant standard's given element names\r
+                       /** \brief Standard USB Configuration Descriptor (USB-IF naming conventions).\r
+                        *\r
+                        *  Type define for a standard Configuration Descriptor header. This structure uses the relevant standard's given element names\r

                         *  to ensure compatibility with the standard.\r
                         *\r
                         *  \see \ref USB_Descriptor_Device_t for the version of this define with non-standard LUFA specific element names\r
                         *  to ensure compatibility with the standard.\r
                         *\r
                         *  \see \ref USB_Descriptor_Device_t for the version of this define with non-standard LUFA specific element names\r


@@ -383,7 +395,9 @@
                                                        */\r
                        } USB_StdDescriptor_Configuration_Header_t;\r
 \r
                                                        */\r
                        } USB_StdDescriptor_Configuration_Header_t;\r
 \r

-                       /** Type define for a standard Interface Descriptor. This structure uses LUFA-specific element names\r
+                       /** \brief Standard USB Interface Descriptor (LUFA naming conventions).\r
+                        *\r
+                        *  Type define for a standard Interface Descriptor. This structure uses LUFA-specific element names\r

                         *  to make each element's purpose clearer.\r
                         *\r
                         *  \see \ref USB_StdDescriptor_Interface_t for the version of this define with standard element names\r
                         *  to make each element's purpose clearer.\r
                         *\r
                         *  \see \ref USB_StdDescriptor_Interface_t for the version of this define with standard element names\r


@@ -409,7 +423,9 @@
                                                                */\r
                        } USB_Descriptor_Interface_t;\r
                        \r
                                                                */\r
                        } USB_Descriptor_Interface_t;\r
                        \r

-                       /** Type define for a standard Interface Descriptor. This structure uses the relevant standard's given element names\r
+                       /** \brief Standard USB Interface Descriptor (USB-IF naming conventions).\r
+                        *\r
+                        *  Type define for a standard Interface Descriptor. This structure uses the relevant standard's given element names\r

                         *  to ensure compatibility with the standard.\r
                         *\r
                         *  \see \ref USB_Descriptor_Interface_t for the version of this define with non-standard LUFA specific element names\r
                         *  to ensure compatibility with the standard.\r
                         *\r
                         *  \see \ref USB_Descriptor_Interface_t for the version of this define with non-standard LUFA specific element names\r


@@ -435,7 +451,9 @@
                                                         */\r
                        } USB_StdDescriptor_Interface_t;\r
 \r
                                                         */\r
                        } USB_StdDescriptor_Interface_t;\r
 \r

-                       /** Type define for a standard Interface Association Descriptor. This structure uses LUFA-specific element names\r
+                       /** \brief Standard USB Interface Association Descriptor (LUFA naming conventions).\r
+                        *\r
+                        *  Type define for a standard Interface Association Descriptor. This structure uses LUFA-specific element names\r

                         *  to make each element's purpose clearer.\r
                         *\r
                         *  This descriptor has been added as a supplement to the USB2.0 standard, in the ECN located at\r
                         *  to make each element's purpose clearer.\r
                         *\r
                         *  This descriptor has been added as a supplement to the USB2.0 standard, in the ECN located at\r


@@ -462,7 +480,9 @@
                                                          */\r
                        } USB_Descriptor_Interface_Association_t;\r
                                \r
                                                          */\r
                        } USB_Descriptor_Interface_Association_t;\r
                                \r

-                       /** Type define for a standard Interface Association Descriptor. This structure uses the relevant standard's given\r
+                       /** \brief Standard USB Interface Association Descriptor (USB-IF naming conventions).\r
+                        *\r
+                        *  Type define for a standard Interface Association Descriptor. This structure uses the relevant standard's given\r

                         *  element names to ensure compatibility with the standard.\r
                         *\r
                         *  This descriptor has been added as a supplement to the USB2.0 standard, in the ECN located at\r
                         *  element names to ensure compatibility with the standard.\r
                         *\r
                         *  This descriptor has been added as a supplement to the USB2.0 standard, in the ECN located at\r


@@ -490,7 +510,9 @@
                                                        */\r
                        } USB_StdDescriptor_Interface_Association_t;\r
 \r
                                                        */\r
                        } USB_StdDescriptor_Interface_Association_t;\r
 \r

-                       /** Type define for a standard Endpoint Descriptor. This structure uses LUFA-specific element names\r
+                       /** \brief Standard USB Endpoint Descriptor (LUFA naming conventions).\r
+                        *\r
+                        *  Type define for a standard Endpoint Descriptor. This structure uses LUFA-specific element names\r

                         *  to make each element's purpose clearer.\r
                         *\r
                         *  \see \ref USB_StdDescriptor_Endpoint_t for the version of this define with standard element names\r
                         *  to make each element's purpose clearer.\r
                         *\r
                         *  \see \ref USB_StdDescriptor_Endpoint_t for the version of this define with standard element names\r


@@ -516,7 +538,9 @@
                                                                */\r
                        } USB_Descriptor_Endpoint_t;\r
                                \r
                                                                */\r
                        } USB_Descriptor_Endpoint_t;\r
                                \r

-                       /** Type define for a standard Endpoint Descriptor. This structure uses the relevant standard's given\r
+                       /** \brief Standard USB Endpoint Descriptor (USB-IF naming conventions).\r
+                        *\r
+                        *  Type define for a standard Endpoint Descriptor. This structure uses the relevant standard's given\r

                         *  element names to ensure compatibility with the standard.\r
                         *\r
                         *  \see \ref USB_Descriptor_Endpoint_t for the version of this define with non-standard LUFA specific\r
                         *  element names to ensure compatibility with the standard.\r
                         *\r
                         *  \see \ref USB_Descriptor_Endpoint_t for the version of this define with non-standard LUFA specific\r


@@ -544,7 +568,9 @@
                                                        */\r
                        } USB_StdDescriptor_Endpoint_t;\r
 \r
                                                        */\r
                        } USB_StdDescriptor_Endpoint_t;\r
 \r

-                       /** Type define for a standard string descriptor. Unlike other standard descriptors, the length\r
+                       /** \brief Standard USB String Descriptor (LUFA naming conventions).\r
+                        *\r
+                        *  Type define for a standard string descriptor. Unlike other standard descriptors, the length\r

                         *  of the descriptor for placement in the descriptor header must be determined by the \ref USB_STRING_LEN()\r
                         *  macro rather than by the size of the descriptor structure, as the length is not fixed.\r
                         *\r
                         *  of the descriptor for placement in the descriptor header must be determined by the \ref USB_STRING_LEN()\r
                         *  macro rather than by the size of the descriptor structure, as the length is not fixed.\r
                         *\r


@@ -572,7 +598,9 @@
                                                           */\r
                        } USB_Descriptor_String_t;\r
 \r
                                                           */\r
                        } USB_Descriptor_String_t;\r
 \r

-                       /** Type define for a standard string descriptor. Unlike other standard descriptors, the length\r
+                       /** \brief Standard USB String Descriptor (USB-IF naming conventions).\r
+                        *\r
+                        *  Type define for a standard string descriptor. Unlike other standard descriptors, the length\r

                         *  of the descriptor for placement in the descriptor header must be determined by the \ref USB_STRING_LEN()\r
                         *  macro rather than by the size of the descriptor structure, as the length is not fixed.\r
                         *\r
                         *  of the descriptor for placement in the descriptor header must be determined by the \ref USB_STRING_LEN()\r
                         *  macro rather than by the size of the descriptor structure, as the length is not fixed.\r
                         *\r