diff options
author | Dean Camera <dean@fourwalledcubicle.com> | 2011-01-08 11:47:20 +0000 |
---|---|---|
committer | Dean Camera <dean@fourwalledcubicle.com> | 2011-01-08 11:47:20 +0000 |
commit | 7dc3d3a68f889efeca5af51b22bd043eff8e0926 (patch) | |
tree | 059fabcc52c5b6fae0d49e7a59795261fcc7bdcc /LUFA/Drivers/USB/HighLevel/ConfigDescriptor.h | |
parent | d1261468875f4772898c4395880735784e651d91 (diff) | |
download | lufa-7dc3d3a68f889efeca5af51b22bd043eff8e0926.tar.gz lufa-7dc3d3a68f889efeca5af51b22bd043eff8e0926.tar.bz2 lufa-7dc3d3a68f889efeca5af51b22bd043eff8e0926.zip |
Minor documentation improvements.
Diffstat (limited to 'LUFA/Drivers/USB/HighLevel/ConfigDescriptor.h')
-rw-r--r-- | LUFA/Drivers/USB/HighLevel/ConfigDescriptor.h | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/LUFA/Drivers/USB/HighLevel/ConfigDescriptor.h b/LUFA/Drivers/USB/HighLevel/ConfigDescriptor.h index 7852ef63d..3ef95a406 100644 --- a/LUFA/Drivers/USB/HighLevel/ConfigDescriptor.h +++ b/LUFA/Drivers/USB/HighLevel/ConfigDescriptor.h @@ -71,7 +71,7 @@ /* Public Interface - May be used in end-application: */ /* Macros: */ /** Mask for determining the type of an endpoint from an endpoint descriptor. This should then be compared - * with the EP_TYPE_* masks to determine the exact type of the endpoint. + * with the \c EP_TYPE_* masks to determine the exact type of the endpoint. */ #define EP_TYPE_MASK 0x03 @@ -152,7 +152,7 @@ { 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_Fail = 1, /**< Comparator function returned \ref DESCRIPTOR_SEARCH_Fail. */ DESCRIPTOR_SEARCH_COMP_EndOfDescriptor = 2, /**< End of configuration descriptor reached before match found. */ }; @@ -162,7 +162,7 @@ * * \param[in] ConfigNumber Device configuration descriptor number to fetch from the device (usually set to 1 for * single configuration devices). - * \param[in,out] ConfigSizePtr Pointer to a uint16_t for storing the retrieved configuration descriptor size. + * \param[in,out] ConfigSizePtr Pointer to a location for storing the retrieved configuration descriptor size. * \param[out] BufferPtr Pointer to the buffer for storing the configuration descriptor data. * \param[out] BufferSize Size of the allocated buffer where the configuration descriptor is to be stored. * |