X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/d97db1120b2b5911a3ea7d77efb9b913b8727bdb..fc31973daffea3506051ce51a5f79383ce0867d6:/LUFA/Drivers/USB/Class/Device/MIDI.h diff --git a/LUFA/Drivers/USB/Class/Device/MIDI.h b/LUFA/Drivers/USB/Class/Device/MIDI.h index 8517782e2..11a05bfbb 100644 --- a/LUFA/Drivers/USB/Class/Device/MIDI.h +++ b/LUFA/Drivers/USB/Class/Device/MIDI.h @@ -28,6 +28,15 @@ this software. */ +/** \file + * \brief Device mode driver for the library USB MIDI Class driver. + * + * Device mode driver for the library USB MIDI Class driver. + * + * \note This file should not be included directly. It is automatically included as needed by the class driver + * dispatch header located in LUFA/Drivers/USB/Class/MIDI.h. + */ + /** \ingroup Group_USBClassMIDI * @defgroup Group_USBClassMIDIDevice MIDI Class Device Mode Driver * @@ -47,7 +56,6 @@ /* Includes: */ #include "../../USB.h" #include "../Common/MIDI.h" - #include "Audio.h" #include @@ -56,9 +64,16 @@ extern "C" { #endif + /* Preprocessor Checks: */ + #if !defined(__INCLUDE_FROM_MIDI_DRIVER) + #error Do not include this file directly. Include LUFA/Drivers/Class/MIDI.h instead. + #endif + /* Public Interface - May be used in end-application: */ /* Type Define: */ - /** Class state structure. An instance of this structure should be made for each MIDI interface + /** \brief MIDI Class Device Mode Configuration and State Structure. + * + * Class state structure. An instance of this structure should be made for each MIDI interface * within the user application, and passed to each of the MIDI class driver functions as the * MIDIInterfaceInfo parameter. This stores each MIDI interface's configuration and state information. */