Minor documentation improvements.

diff --git a/LUFA/Drivers/USB/Class/Common/AudioClassCommon.h b/LUFA/Drivers/USB/Class/Common/AudioClassCommon.h
index 4ce585e..0ce4597 100644 (file)
--- 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.
                                                          */
 
                                                          *   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). */
                        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.
                                                     */
 
                                                     *   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). */
                        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 7acfdaf..c778224 100644 (file)
--- 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.
                                                          */
                        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;
 
                                                                   */
                } 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.
                                                      */
                        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).
                } 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 b51b217..3c30daa 100644 (file)
--- 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. */
 
                {
                        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. */
                        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.
                                                   */
 
                                                   *   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. */
                        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 9bb042c..8c48970 100644 (file)
--- 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.
 
                        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;
                                                                     */
                        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. */
 
 
                        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;
 
                        uint16_t wTotalLength; /**< Total length of the Audio class-specific descriptors, including this descriptor. */
                } ATTR_PACKED USB_MIDI_StdDescriptor_AudioInterface_AS_t;
 

diff --git a/LUFA/Drivers/USB/Core/StdDescriptors.h b/LUFA/Drivers/USB/Core/StdDescriptors.h
index 3ed735f..d7f0ca3 100644 (file)
--- a/LUFA/Drivers/USB/Core/StdDescriptors.h
+++ b/LUFA/Drivers/USB/Core/StdDescriptors.h
@@ -275,7 +275,10 @@
                        {
                                USB_Descriptor_Header_t Header; /**< Descriptor header, including type and size. */
 
                        {
                                USB_Descriptor_Header_t Header; /**< Descriptor header, including type and size. */
 

-                               uint16_t USBSpecification; /**< BCD of the supported USB specification. */
+                               uint16_t USBSpecification; /**< BCD of the supported USB specification.
+                                                           *
+                                                           *   \see \ref VERSION_BCD() utility macro.
+                                                           */

                                uint8_t  Class; /**< USB device class. */
                                uint8_t  SubClass; /**< USB device subclass. */
                                uint8_t  Protocol; /**< USB device protocol. */
                                uint8_t  Class; /**< USB device class. */
                                uint8_t  SubClass; /**< USB device subclass. */
                                uint8_t  Protocol; /**< USB device protocol. */


@@ -284,8 +287,10 @@
 
                                uint16_t VendorID; /**< Vendor ID for the USB product. */
                                uint16_t ProductID; /**< Unique product ID for the USB product. */
 
                                uint16_t VendorID; /**< Vendor ID for the USB product. */
                                uint16_t ProductID; /**< Unique product ID for the USB product. */

-                               uint16_t ReleaseNumber; /**< Product release (version) number. */
-
+                               uint16_t ReleaseNumber; /**< Product release (version) number.
+                                                        *
+                                                        *   \see \ref VERSION_BCD() utility macro.
+                                                        */

                                uint8_t  ManufacturerStrIndex; /**< String index for the manufacturer's name. The
                                                                *   host will request this string via a separate
                                                                *   control request for the string descriptor.
                                uint8_t  ManufacturerStrIndex; /**< String index for the manufacturer's name. The
                                                                *   host will request this string via a separate
                                                                *   control request for the string descriptor.


@@ -301,12 +306,12 @@
                                                             *
                                                             *  \note On some microcontroller models, there is an embedded serial number
                                                             *        in the chip which can be used for the device serial number.
                                                             *
                                                             *  \note On some microcontroller models, there is an embedded serial number
                                                             *        in the chip which can be used for the device serial number.

-                                                            *        To use this serial number, set this to USE_INTERNAL_SERIAL.
-                                                            *        On unsupported devices, this will evaluate to 0 and will cause
-                                                            *        the host to generate a pseudo-unique value for the device upon
-                                                            *        insertion.
+                                                            *        To use this serial number, set this to \c USE_INTERNAL_SERIAL.
+                                                            *        On unsupported devices, this will evaluate to \ref NO_DESCRIPTOR
+                                                            *        and will cause the host to generate a pseudo-unique value for the
+                                                            *        device upon insertion.

                                                             *
                                                             *

-                                                            *  \see ManufacturerStrIndex structure entry.
+                                                            *  \see \c ManufacturerStrIndex structure entry.

                                                             */
                                uint8_t  NumberOfConfigurations; /**< Total number of configurations supported by
                                                                  *   the device.
                                                             */
                                uint8_t  NumberOfConfigurations; /**< Total number of configurations supported by
                                                                  *   the device.


@@ -328,14 +333,20 @@
                                uint8_t  bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value
                                                              *   given by the specific class.
                                                              */
                                uint8_t  bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value
                                                              *   given by the specific class.
                                                              */

-                               uint16_t bcdUSB; /**< BCD of the supported USB specification. */
+                               uint16_t bcdUSB; /**< BCD of the supported USB specification.
+                                                 *
+                                                 *   \see \ref VERSION_BCD() utility macro.
+                                                 */

                                uint8_t  bDeviceClass; /**< USB device class. */
                                uint8_t  bDeviceSubClass; /**< USB device subclass. */
                                uint8_t  bDeviceProtocol; /**< USB device protocol. */
                                uint8_t  bMaxPacketSize0; /**< Size of the control (address 0) endpoint's bank in bytes. */
                                uint16_t idVendor; /**< Vendor ID for the USB product. */
                                uint16_t idProduct; /**< Unique product ID for the USB product. */
                                uint8_t  bDeviceClass; /**< USB device class. */
                                uint8_t  bDeviceSubClass; /**< USB device subclass. */
                                uint8_t  bDeviceProtocol; /**< USB device protocol. */
                                uint8_t  bMaxPacketSize0; /**< Size of the control (address 0) endpoint's bank in bytes. */
                                uint16_t idVendor; /**< Vendor ID for the USB product. */
                                uint16_t idProduct; /**< Unique product ID for the USB product. */

-                               uint16_t bcdDevice; /**< Product release (version) number. */
+                               uint16_t bcdDevice; /**< Product release (version) number.
+                                                    *
+                                                    *   \see \ref VERSION_BCD() utility macro.
+                                                    */

                                uint8_t  iManufacturer; /**< String index for the manufacturer's name. The
                                                         *   host will request this string via a separate
                                                         *   control request for the string descriptor.
                                uint8_t  iManufacturer; /**< String index for the manufacturer's name. The
                                                         *   host will request this string via a separate
                                                         *   control request for the string descriptor.


@@ -351,12 +362,12 @@
                                                        *
                                                        *  \note On some microcontroller models, there is an embedded serial number
                                                        *        in the chip which can be used for the device serial number.
                                                        *
                                                        *  \note On some microcontroller models, there is an embedded serial number
                                                        *        in the chip which can be used for the device serial number.

-                                                       *        To use this serial number, set this to USE_INTERNAL_SERIAL.
-                                                       *        On unsupported devices, this will evaluate to 0 and will cause
-                                                       *        the host to generate a pseudo-unique value for the device upon
-                                                       *        insertion.
+                                                       *        To use this serial number, set this to \c USE_INTERNAL_SERIAL.
+                                                       *        On unsupported devices, this will evaluate to \ref NO_DESCRIPTOR
+                                                       *        and will cause the host to generate a pseudo-unique value for the
+                                                       *        device upon insertion.

                                                        *
                                                        *

-                                                       *  \see ManufacturerStrIndex structure entry.
+                                                       *  \see \c ManufacturerStrIndex structure entry.

                                                        */
                                uint8_t  bNumConfigurations; /**< Total number of configurations supported by
                                                              *   the device.
                                                        */
                                uint8_t  bNumConfigurations; /**< Total number of configurations supported by
                                                              *   the device.


@@ -374,7 +385,10 @@
                        {
                                USB_Descriptor_Header_t Header; /**< Descriptor header, including type and size. */
 
                        {
                                USB_Descriptor_Header_t Header; /**< Descriptor header, including type and size. */
 

-                               uint16_t USBSpecification; /**< BCD of the supported USB specification. */
+                               uint16_t USBSpecification; /**< BCD of the supported USB specification.
+                                                           *
+                                                           *   \see \ref VERSION_BCD() utility macro.
+                                                           */

                                uint8_t  Class; /**< USB device class. */
                                uint8_t  SubClass; /**< USB device subclass. */
                                uint8_t  Protocol; /**< USB device protocol. */
                                uint8_t  Class; /**< USB device class. */
                                uint8_t  SubClass; /**< USB device subclass. */
                                uint8_t  Protocol; /**< USB device protocol. */


@@ -397,9 +411,12 @@
                        {
                                uint8_t  bLength; /**< Size of the descriptor, in bytes. */
                                uint8_t  bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value
                        {
                                uint8_t  bLength; /**< Size of the descriptor, in bytes. */
                                uint8_t  bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value

-                                                             *   given by the specific class.
-                                                             */
-                               uint16_t bcdUSB; /**< BCD of the supported USB specification. */
+                                                          *   given by the specific class.
+                                                          */
+                               uint16_t bcdUSB; /**< BCD of the supported USB specification.
+                                                 *
+                                                 *   \see \ref VERSION_BCD() utility macro.
+                                                 */

                                uint8_t  bDeviceClass; /**< USB device class. */
                                uint8_t  bDeviceSubClass; /**< USB device subclass. */
                                uint8_t  bDeviceProtocol; /**< USB device protocol. */
                                uint8_t  bDeviceClass; /**< USB device class. */
                                uint8_t  bDeviceSubClass; /**< USB device subclass. */
                                uint8_t  bDeviceProtocol; /**< USB device protocol. */


@@ -454,8 +471,8 @@
                        {
                                uint8_t  bLength; /**< Size of the descriptor, in bytes. */
                                uint8_t  bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value
                        {
                                uint8_t  bLength; /**< Size of the descriptor, in bytes. */
                                uint8_t  bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value

-                                                             *   given by the specific class.
-                                                             */
+                                                          *   given by the specific class.
+                                                          */

                                uint16_t wTotalLength; /**< Size of the configuration descriptor header,
                                                           *   and all sub descriptors inside the configuration.
                                                           */
                                uint16_t wTotalLength; /**< Size of the configuration descriptor header,
                                                           *   and all sub descriptors inside the configuration.
                                                           */