From 707934d9cbbebc7c3ae57a69af4b4ee82baae22a Mon Sep 17 00:00:00 2001 From: Dean Camera Date: Sun, 12 May 2013 12:04:58 +0200 Subject: Minor documentation improvements. --- LUFA/Drivers/USB/Class/Common/AudioClassCommon.h | 10 ++++++++-- LUFA/Drivers/USB/Class/Common/CDCClassCommon.h | 7 ++++++- LUFA/Drivers/USB/Class/Common/HIDClassCommon.h | 10 ++++++++-- LUFA/Drivers/USB/Class/Common/MIDIClassCommon.h | 7 ++++++- 4 files changed, 28 insertions(+), 6 deletions(-) (limited to 'LUFA/Drivers/USB/Class') 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). */ diff --git a/LUFA/Drivers/USB/Class/Common/CDCClassCommon.h b/LUFA/Drivers/USB/Class/Common/CDCClassCommon.h index 7acfdafd3..c77822427 100644 --- a/LUFA/Drivers/USB/Class/Common/CDCClassCommon.h +++ b/LUFA/Drivers/USB/Class/Common/CDCClassCommon.h @@ -242,6 +242,8 @@ */ uint16_t CDCSpecification; /**< Version number of the CDC specification implemented by the device, * encoded in BCD format. + * + * \see \ref VERSION_BCD() utility macro. */ } ATTR_PACKED USB_CDC_Descriptor_FunctionalHeader_t; @@ -265,7 +267,10 @@ uint8_t bDescriptorSubType; /**< Sub type value used to distinguish between CDC class-specific descriptors, * must be \ref CDC_DSUBTYPE_CSInterface_Header. */ - uint16_t bcdCDC; /**< Version number of the CDC specification implemented by the device, encoded in BCD format. */ + uint16_t bcdCDC; /**< Version number of the CDC specification implemented by the device, encoded in BCD format. + * + * \see \ref VERSION_BCD() utility macro. + */ } ATTR_PACKED USB_CDC_StdDescriptor_FunctionalHeader_t; /** \brief CDC class-specific Functional ACM Descriptor (LUFA naming conventions). diff --git a/LUFA/Drivers/USB/Class/Common/HIDClassCommon.h b/LUFA/Drivers/USB/Class/Common/HIDClassCommon.h index b51b217d7..3c30daa9e 100644 --- a/LUFA/Drivers/USB/Class/Common/HIDClassCommon.h +++ b/LUFA/Drivers/USB/Class/Common/HIDClassCommon.h @@ -586,7 +586,10 @@ { USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */ - uint16_t HIDSpec; /**< BCD encoded version that the HID descriptor and device complies to. */ + uint16_t HIDSpec; /**< BCD encoded version that the HID descriptor and device complies to. + * + * \see \ref VERSION_BCD() utility macro. + */ uint8_t CountryCode; /**< Country code of the localized device, or zero if universal. */ uint8_t TotalReportDescriptors; /**< Total number of HID report descriptors for the interface. */ @@ -612,7 +615,10 @@ * given by the specific class. */ - uint16_t bcdHID; /**< BCD encoded version that the HID descriptor and device complies to. */ + uint16_t bcdHID; /**< BCD encoded version that the HID descriptor and device complies to. + * + * \see \ref VERSION_BCD() utility macro. + */ uint8_t bCountryCode; /**< Country code of the localized device, or zero if universal. */ uint8_t bNumDescriptors; /**< Total number of HID report descriptors for the interface. */ diff --git a/LUFA/Drivers/USB/Class/Common/MIDIClassCommon.h b/LUFA/Drivers/USB/Class/Common/MIDIClassCommon.h index 9bb042cb7..8c4897036 100644 --- a/LUFA/Drivers/USB/Class/Common/MIDIClassCommon.h +++ b/LUFA/Drivers/USB/Class/Common/MIDIClassCommon.h @@ -163,6 +163,8 @@ uint16_t AudioSpecification; /**< 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. */ } ATTR_PACKED USB_MIDI_Descriptor_AudioInterface_AS_t; @@ -187,7 +189,10 @@ uint8_t bDescriptorSubtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */ - uint16_t bcdMSC; /**< Binary coded decimal value, indicating the supported MIDI Class specification version. */ + uint16_t bcdMSC; /**< Binary coded decimal value, indicating the supported MIDI Class specification version. + * + * \see \ref VERSION_BCD() utility macro. + */ uint16_t wTotalLength; /**< Total length of the Audio class-specific descriptors, including this descriptor. */ } ATTR_PACKED USB_MIDI_StdDescriptor_AudioInterface_AS_t; -- cgit v1.2.3