More minor renaming of library enums and events to try to create a consistent API.

[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 362a43e..dce7de7 100644 (file)
--- a/LUFA/Drivers/USB/Class/ConfigDescriptor.h
+++ b/LUFA/Drivers/USB/Class/ConfigDescriptor.h
@@ -118,7 +118,7 @@
                         *  for certain descriptors matching unique criteria.\r
                         *\r
                         *  Comparator routines are passed in a single pointer named CurrentDescriptor, and should return a value\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 \ref DSearch_Return_ErrorCodes_t enum.\r

                         */\r
                        #define DESCRIPTOR_COMPARATOR(name)           uint8_t DCOMP_##name (void* const CurrentDescriptor)\r
 \r
                         */\r
                        #define DESCRIPTOR_COMPARATOR(name)           uint8_t DCOMP_##name (void* const CurrentDescriptor)\r
 \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
                                 *  \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
                                 *\r
                                 *  Usage Example:\r
                                 *  \code\r


@@ -162,11 +162,11 @@
                                 */\r
                                uint8_t USB_GetNextDescriptorComp(uint16_t* BytesRem, uint8_t** CurrConfigLoc, ComparatorPtr_t ComparatorRoutine);\r
                        #else\r
                                 */\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
                        #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
                        enum DSearch_Return_ErrorCodes_t\r
                        {\r
                                DESCRIPTOR_SEARCH_Found                = 0, /**< Current descriptor matches comparator criteria. */\r


@@ -174,7 +174,7 @@
                                DESCRIPTOR_SEARCH_NotFound             = 2, /**< Current descriptor does not match comparator criteria. */\r
                        };\r
 \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
                        enum DSearch_Comp_Return_ErrorCodes_t\r
                        {\r
                                DESCRIPTOR_SEARCH_COMP_Found           = 0, /**< Configuration descriptor now points to descriptor which matches\r


@@ -270,7 +270,7 @@
                        typedef uint8_t (* const ComparatorPtr_t)(void* const);\r
 \r
                /* Function Prototypes: */\r
                        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
        #endif\r
                        \r
        /* Disable C linkage for C++ Compilers: */\r