Fixed GenericHIDHost demo report write routine incorrect for control type requests...
[pub/USBasp.git] / LUFA / Drivers / USB / Class / ConfigDescriptor.h
index bd92b51..d5fcbb0 100644 (file)
  *  and other descriptor data can be extracted and used as needed.\r
  */\r
 \r
+/** \ingroup Group_Descriptors\r
+ *  @defgroup Group_ConfigDescriptorParser Configuration Descriptor Parser\r
+ *\r
+ *  Functions, macros, variables, enums and types related to the parsing of Configuration Descriptors.\r
+ *\r
+ *  @{\r
+ */\r
+\r
 #ifndef __CONFIGDESCRIPTOR_H__\r
 #define __CONFIGDESCRIPTOR_H__\r
 \r
                         *  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 DSearch_Return_ErrorCodes_t enum.\r
                         */\r
                        #define DESCRIPTOR_COMPARATOR(name)           uint8_t DCOMP_##name (void* const CurrentDescriptor)\r
 \r
                         *  \param DPos     Pointer to the current position in the configuration descriptor\r
                         *  \param DSearch  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 DSearch_Comp_Return_ErrorCodes_t enum\r
                         *\r
                         *  Usage Example:\r
                         *  \code\r
                                                                      USB_Host_GetNextDescriptorComp_P(DSize, DPos, DCOMP_##DSearch)\r
                /* Enums: */\r
                        /** Enum for return values of a descriptor comparator made with DESCRIPTOR_COMPARATOR. */\r
-                       enum DSEARCH_Return_ErrorCodes_t\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
                        };\r
 \r
                        /** Enum for return values of USB_Host_GetNextDescriptorComp() */\r
-                       enum DSEARCH_Comp_Return_ErrorCodes_t\r
+                       enum DSearch_Comp_Return_ErrorCodes_t\r
                        {\r
                                Descriptor_Search_Comp_Found           = 0, /**< Configuration descriptor now points to descriptor which matches\r
                                                                             *   search criteria of the given comparator function. */\r
                #if defined(__cplusplus)\r
                        }\r
                #endif\r
-               \r
+\r
 #endif\r
+\r
+/** @} */\r