Minor documentation improvements.
[pub/USBasp.git] / LUFA / Drivers / USB / Class / Common / AudioClassCommon.h
index 32a6640..e97e7c9 100644 (file)
@@ -1,13 +1,13 @@
 /*
              LUFA Library
-     Copyright (C) Dean Camera, 2011.
+     Copyright (C) Dean Camera, 2012.
 
   dean [at] fourwalledcubicle [dot] com
            www.lufa-lib.org
 */
 
 /*
-  Copyright 2011  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2012  Dean Camera (dean [at] fourwalledcubicle [dot] com)
 
   Permission to use, copy, modify, distribute, and sell this
   software and its documentation for any purpose is hereby granted
                 *  allows for pitch adjustments to be made via control requests directed at the endpoint.
                 */
                #define AUDIO_EP_PITCH_CONTROL            (1 << 1)
-               
+
        /* Enums: */
                /** Enum for possible Class, Subclass and Protocol values of device and interface descriptors relating to the Audio
                 *  device class.
                                                                           *   interface belongs to the Streaming Audio protocol.
                                                                           */
                };
-       
+
                /** Audio class specific interface description subtypes, for the Audio Control interface. */
                enum Audio_CSInterface_AC_SubTypes_t
                {
                        AUDIO_REQ_GetMemory     = 0x85, /**< Audio class-specific request to get the memory value of a parameter within the device. */
                        AUDIO_REQ_GetStatus     = 0xFF, /**< Audio class-specific request to get the device status. */
                };
-               
+
                /** Enum for Audio class specific Endpoint control modifiers which can be set and retrieved by a USB host, if the corresponding
                 *  endpoint control is indicated to be supported in the Endpoint's Audio-class specific endpoint descriptor.
                 */
                 *  about the number of channels, the sample resolution, acceptable sample frequencies and encoding method used
                 *  in the device's audio streams. See the USB Audio specification for more details.
                 *
-                *  \note This descriptor <b>must</b> be followed by one or more \ref USB_Audio_SampleFreq_t elements containing
-                *        the continuous or discrete sample frequencies.
+                *  \attention This descriptor <b>must</b> be followed by one or more \ref USB_Audio_SampleFreq_t elements containing
+                *             the continuous or discrete sample frequencies.
                 *
                 *  \see \ref USB_Audio_StdDescriptor_Format_t for the version of this type with standard element names.
                 *
                 *  about the number of channels, the sample resolution, acceptable sample frequencies and encoding method used
                 *  in the device's audio streams. See the USB Audio specification for more details.
                 *
-                *  \note This descriptor <b>must</b> be followed by one or more 24-bit integer elements containing the continuous
-                *        or discrete sample frequencies.
+                *  \attention This descriptor <b>must</b> be followed by one or more 24-bit integer elements containing the continuous
+                *             or discrete sample frequencies.
                 *
                 *  \see \ref USB_Audio_Descriptor_Format_t for the version of this type with non-standard LUFA specific
                 *       element names.