X-Git-Url: http://git.linex4red.de/pub/lufa.git/blobdiff_plain/32e735b2b2eefb74e0415a5826692f7ba8c0a984..c20a94a4e84c89debf5e7109482ede708a694a0c:/LUFA/Drivers/USB/Class/ConfigDescriptor.h diff --git a/LUFA/Drivers/USB/Class/ConfigDescriptor.h b/LUFA/Drivers/USB/Class/ConfigDescriptor.h index 7a1d53118..da38492ff 100644 --- a/LUFA/Drivers/USB/Class/ConfigDescriptor.h +++ b/LUFA/Drivers/USB/Class/ConfigDescriptor.h @@ -118,11 +118,11 @@ * for certain descriptors matching unique criteria. * * Comparator routines are passed in a single pointer named CurrentDescriptor, and should return a value - * of a member of the DSearch_Return_ErrorCodes_t enum. + * of a member of the \ref DSearch_Return_ErrorCodes_t enum. */ #define DESCRIPTOR_COMPARATOR(name) uint8_t DCOMP_##name (void* const CurrentDescriptor) - /* Psuedo-Functions: */ + /* Pseudo-Function Macros: */ #if defined(__DOXYGEN__) /** Searches for the next descriptor in the given configuration descriptor using a premade comparator * function. The routine updates the position and remaining configuration descriptor bytes values @@ -137,7 +137,7 @@ * \param CurrConfigLoc Pointer to the current position in the configuration descriptor * \param ComparatorRoutine Name of the comparator search function to use on the configuration descriptor * - * \return Value of one of the members of the DSearch_Comp_Return_ErrorCodes_t enum + * \return Value of one of the members of the \ref DSearch_Comp_Return_ErrorCodes_t enum * * Usage Example: * \code @@ -146,9 +146,9 @@ * DESCRIPTOR_COMPARATOR(EndpointSearcher) * { * if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Endpoint) - * return Descriptor_Search_Found; + * return DESCRIPTOR_SEARCH_Found; * else - * return Descriptor_Search_NotFound; + * return DESCRIPTOR_SEARCH_NotFound; * } * * //... @@ -166,21 +166,21 @@ #endif /* Enums: */ - /** Enum for return values of a descriptor comparator made with DESCRIPTOR_COMPARATOR. */ + /** Enum for return values of a descriptor comparator made with \ref DESCRIPTOR_COMPARATOR. */ enum DSearch_Return_ErrorCodes_t { - Descriptor_Search_Found = 0, /**< Current descriptor matches comparator criteria. */ - Descriptor_Search_Fail = 1, /**< No further descriptor could possibly match criteria, fail the search. */ - Descriptor_Search_NotFound = 2, /**< Current descriptor does not match comparator criteria. */ + DESCRIPTOR_SEARCH_Found = 0, /**< Current descriptor matches comparator criteria. */ + DESCRIPTOR_SEARCH_Fail = 1, /**< No further descriptor could possibly match criteria, fail the search. */ + DESCRIPTOR_SEARCH_NotFound = 2, /**< Current descriptor does not match comparator criteria. */ }; - /** Enum for return values of USB_GetNextDescriptorComp(). */ + /** Enum for return values of \ref USB_GetNextDescriptorComp(). */ enum DSearch_Comp_Return_ErrorCodes_t { - Descriptor_Search_Comp_Found = 0, /**< Configuration descriptor now points to descriptor which matches + DESCRIPTOR_SEARCH_COMP_Found = 0, /**< Configuration descriptor now points to descriptor which matches * search criteria of the given comparator function. */ - Descriptor_Search_Comp_Fail = 1, /**< Comparator function returned Descriptor_Search_Fail. */ - Descriptor_Search_Comp_EndOfDescriptor = 2, /**< End of configuration descriptor reached before match found. */ + DESCRIPTOR_SEARCH_COMP_Fail = 1, /**< Comparator function returned Descriptor_Search_Fail. */ + DESCRIPTOR_SEARCH_COMP_EndOfDescriptor = 2, /**< End of configuration descriptor reached before match found. */ }; /* Function Prototypes: */