Add updated board driver directory summaries to the documentation.

[pub/USBasp.git] / LUFA / Drivers / USB / Class / Device / Audio.h

diff --git a/LUFA/Drivers/USB/Class/Device/Audio.h b/LUFA/Drivers/USB/Class/Device/Audio.h
index c6b68b0..053b69a 100644 (file)
--- a/LUFA/Drivers/USB/Class/Device/Audio.h
+++ b/LUFA/Drivers/USB/Class/Device/Audio.h
@@ -28,6 +28,15 @@
   this software.\r
 */\r
 \r
+/** \file\r
+ *  \brief Device mode driver for the library USB Audio Class driver.\r
+ *\r
+ *  Device mode driver for the library USB Audio Class driver.\r
+ *\r
+ *  \note This file should not be included directly. It is automatically included as needed by the class driver\r
+ *        dispatch header located in LUFA/Drivers/USB/Class/Audio.h.\r
+ */\r
+\r
 /** \ingroup Group_USBClassAudio\r
  *  @defgroup Group_USBClassAudioDevice Audio Class Device Mode Driver\r
  *\r
@@ -55,9 +64,16 @@
                        extern "C" {\r
                #endif\r
 \r
+       /* Preprocessor Checks: */\r
+               #if !defined(__INCLUDE_FROM_AUDIO_DRIVER)\r
+                       #error Do not include this file directly. Include LUFA/Drivers/Class/Audio.h instead.\r
+               #endif\r
+\r
        /* Public Interface - May be used in end-application: */\r
-               /* Type Defines: */             \r
-                       /** Class state structure. An instance of this structure should be made for each Audio interface\r
+               /* Type Defines: */\r
+                       /** \brief Audio Class Device Mode Configuration and State Structure.\r
+                        *\r
+                        *  Class state structure. An instance of this structure should be made for each Audio interface\r
                         *  within the user application, and passed to each of the Audio class driver functions as the\r
                         *  AudioInterfaceInfo parameter. This stores each Audio interface's configuration and state information.\r
                         */\r