aboutsummaryrefslogtreecommitdiffstats
path: root/LUFA/Drivers/USB/Class/Common/AudioClassCommon.h
diff options
context:
space:
mode:
authorDean Camera <dean@fourwalledcubicle.com>2013-05-12 12:04:58 +0200
committerDean Camera <dean@fourwalledcubicle.com>2013-05-12 12:04:58 +0200
commit707934d9cbbebc7c3ae57a69af4b4ee82baae22a (patch)
tree8e444afd36c93c33702e570123726b84338000eb /LUFA/Drivers/USB/Class/Common/AudioClassCommon.h
parent6dde58547559506a81ccea7f39f080530c716d98 (diff)
downloadlufa-707934d9cbbebc7c3ae57a69af4b4ee82baae22a.tar.gz
lufa-707934d9cbbebc7c3ae57a69af4b4ee82baae22a.tar.bz2
lufa-707934d9cbbebc7c3ae57a69af4b4ee82baae22a.zip
Minor documentation improvements.
Diffstat (limited to 'LUFA/Drivers/USB/Class/Common/AudioClassCommon.h')
-rw-r--r--LUFA/Drivers/USB/Class/Common/AudioClassCommon.h10
1 files changed, 8 insertions, 2 deletions
diff --git a/LUFA/Drivers/USB/Class/Common/AudioClassCommon.h b/LUFA/Drivers/USB/Class/Common/AudioClassCommon.h
index 4ce585eb7..0ce459788 100644
--- a/LUFA/Drivers/USB/Class/Common/AudioClassCommon.h
+++ b/LUFA/Drivers/USB/Class/Common/AudioClassCommon.h
@@ -435,7 +435,10 @@
* a value from the \ref Audio_CSInterface_AS_SubTypes_t enum.
*/
- uint16_t ACSpecification; /**< Binary coded decimal value, indicating the supported Audio Class specification version. */
+ uint16_t ACSpecification; /**< Binary Coded Decimal value, indicating the supported Audio Class specification version.
+ *
+ * \see \ref VERSION_BCD() utility macro.
+ */
uint16_t TotalLength; /**< Total length of the Audio class-specific descriptors, including this descriptor. */
uint8_t InCollection; /**< Total number of Audio Streaming interfaces linked to this Audio Control interface (must be 1). */
@@ -464,7 +467,10 @@
* a value from the \ref Audio_CSInterface_AS_SubTypes_t enum.
*/
- uint16_t bcdADC; /**< Binary coded decimal value, indicating the supported Audio Class specification version. */
+ uint16_t bcdADC; /**< Binary coded decimal value, indicating the supported Audio Class specification version.
+ *
+ * \see \ref VERSION_BCD() utility macro.
+ */
uint16_t wTotalLength; /**< Total length of the Audio class-specific descriptors, including this descriptor. */
uint8_t bInCollection; /**< Total number of Audio Streaming interfaces linked to this Audio Control interface (must be 1). */