Fixed bug in RNDISEthernet and DualCDC demos not using the correct USB_ControlRequest...

[pub/USBasp.git] / LUFA / Drivers / USB / Class / ConfigDescriptor.h

diff --git a/LUFA/Drivers/USB/Class/ConfigDescriptor.h b/LUFA/Drivers/USB/Class/ConfigDescriptor.h
index 7a1d531..6f5bbc4 100644 (file)
--- a/LUFA/Drivers/USB/Class/ConfigDescriptor.h
+++ b/LUFA/Drivers/USB/Class/ConfigDescriptor.h
@@ -96,7 +96,7 @@
 \r
                        /** Returns the descriptor's type, expressed as the 8-bit type value in the header of the descriptor.\r
                         *  This value's meaning depends on the descriptor's placement in the descriptor, but standard type\r
-                        *  values can be accessed in the DescriptorTypes_t enum located in USB/HighLevel/StdDescriptors.h.\r
+                        *  values can be accessed in the \ref USB_DescriptorTypes_t enum.\r
                         */\r
                        #if defined(USE_NONSTANDARD_DESCRIPTOR_NAMES) || defined(__DOXYGEN__)\r
                                #define DESCRIPTOR_TYPE(DescriptorPtr)    DESCRIPTOR_CAST(DescriptorPtr, USB_Descriptor_Header_t).Type\r
@@ -118,11 +118,11 @@
                         *  for certain descriptors matching unique criteria.\r
                         *\r
                         *  Comparator routines are passed in a single pointer named CurrentDescriptor, and should return a value\r
-                        *  of a member of the DSearch_Return_ErrorCodes_t enum.\r
+                        *  of a member of the \ref DSearch_Return_ErrorCodes_t enum.\r
                         */\r
                        #define DESCRIPTOR_COMPARATOR(name)           uint8_t DCOMP_##name (void* const CurrentDescriptor)\r
 \r
-               /* Psuedo-Functions: */\r
+               /* Pseudo-Function Macros: */\r
                        #if defined(__DOXYGEN__)\r
                                /** Searches for the next descriptor in the given configuration descriptor using a premade comparator\r
                                 *  function. The routine updates the position and remaining configuration descriptor bytes values\r
@@ -137,7 +137,7 @@
                                 *  \param CurrConfigLoc  Pointer to the current position in the configuration descriptor\r
                                 *  \param ComparatorRoutine  Name of the comparator search function to use on the configuration descriptor\r
                                 *\r
-                                *  \return Value of one of the members of the DSearch_Comp_Return_ErrorCodes_t enum\r
+                                *  \return Value of one of the members of the \ref DSearch_Comp_Return_ErrorCodes_t enum\r
                                 *\r
                                 *  Usage Example:\r
                                 *  \code\r
@@ -146,9 +146,9 @@
                                 *  DESCRIPTOR_COMPARATOR(EndpointSearcher)\r
                                 *  {\r
                                 *     if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Endpoint)\r
-                                *         return Descriptor_Search_Found;\r
+                                *         return DESCRIPTOR_SEARCH_Found;\r
                                 *     else\r
-                                *         return Descriptor_Search_NotFound;\r
+                                *         return DESCRIPTOR_SEARCH_NotFound;\r
                                 *  }\r
                                 *\r
                                 *  //...\r
@@ -162,25 +162,25 @@
                                 */\r
                                uint8_t USB_GetNextDescriptorComp(uint16_t* BytesRem, uint8_t** CurrConfigLoc, ComparatorPtr_t ComparatorRoutine);\r
                        #else\r
-                               #define USB_GetNextDescriptorComp(DSize, DPos, DSearch) USB_GetNextDescriptorComp_P(DSize, DPos, DCOMP_##DSearch)\r
+                               #define USB_GetNextDescriptorComp(DSize, DPos, DSearch) USB_GetNextDescriptorComp_Prv(DSize, DPos, DCOMP_##DSearch)\r
                        #endif\r
                        \r
                /* Enums: */\r
-                       /** Enum for return values of a descriptor comparator made with DESCRIPTOR_COMPARATOR. */\r
+                       /** Enum for return values of a descriptor comparator made with \ref DESCRIPTOR_COMPARATOR. */\r
                        enum DSearch_Return_ErrorCodes_t\r
                        {\r
-                               Descriptor_Search_Found                = 0, /**< Current descriptor matches comparator criteria. */\r
-                               Descriptor_Search_Fail                 = 1, /**< No further descriptor could possibly match criteria, fail the search. */\r
-                               Descriptor_Search_NotFound             = 2, /**< Current descriptor does not match comparator criteria. */\r
+                               DESCRIPTOR_SEARCH_Found                = 0, /**< Current descriptor matches comparator criteria. */\r
+                               DESCRIPTOR_SEARCH_Fail                 = 1, /**< No further descriptor could possibly match criteria, fail the search. */\r
+                               DESCRIPTOR_SEARCH_NotFound             = 2, /**< Current descriptor does not match comparator criteria. */\r
                        };\r
 \r
-                       /** Enum for return values of USB_GetNextDescriptorComp(). */\r
+                       /** Enum for return values of \ref USB_GetNextDescriptorComp(). */\r
                        enum DSearch_Comp_Return_ErrorCodes_t\r
                        {\r
-                               Descriptor_Search_Comp_Found           = 0, /**< Configuration descriptor now points to descriptor which matches\r
+                               DESCRIPTOR_SEARCH_COMP_Found           = 0, /**< Configuration descriptor now points to descriptor which matches\r
                                                                             *   search criteria of the given comparator function. */\r
-                               Descriptor_Search_Comp_Fail            = 1, /**< Comparator function returned Descriptor_Search_Fail. */\r
-                               Descriptor_Search_Comp_EndOfDescriptor = 2, /**< End of configuration descriptor reached before match found. */\r
+                               DESCRIPTOR_SEARCH_COMP_Fail            = 1, /**< Comparator function returned Descriptor_Search_Fail. */\r
+                               DESCRIPTOR_SEARCH_COMP_EndOfDescriptor = 2, /**< End of configuration descriptor reached before match found. */\r
                        };\r
        \r
                /* Function Prototypes: */\r
@@ -270,7 +270,7 @@
                        typedef uint8_t (* const ComparatorPtr_t)(void* const);\r
 \r
                /* Function Prototypes: */\r
-                       uint8_t USB_GetNextDescriptorComp_P(uint16_t* BytesRem, uint8_t** CurrConfigLoc, ComparatorPtr_t ComparatorRoutine);\r
+                       uint8_t USB_GetNextDescriptorComp_Prv(uint16_t* BytesRem, uint8_t** CurrConfigLoc, ComparatorPtr_t ComparatorRoutine);\r
        #endif\r
                        \r
        /* Disable C linkage for C++ Compilers: */\r