Enhanced class drivers to use the same public/private section seperations as other...

[pub/USBasp.git] / 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 0963aab..87aabe1 100644 (file)
--- a/LUFA/Drivers/USB/Class/Device/MIDI.h
+++ b/LUFA/Drivers/USB/Class/Device/MIDI.h
@@ -52,46 +52,47 @@
                        extern "C" {\r
                #endif\r
 \r
                        extern "C" {\r
                #endif\r
 \r

-       /* Function Prototypes: */\r
-               /** Configures the endpoints of a given MIDI interface, ready for use. This should be linked to the library\r
-                *  \ref EVENT_USB_ConfigurationChanged() event so that the endpoints are configured when the configuration\r
-                *  containing the given MIDI interface is selected.\r
-                *\r
-                *  \param MIDIInterfaceInfo  Pointer to a structure containing a MIDI Class configuration and state.\r
-                *\r
-                *  \return Boolean true if the endpoints were sucessfully configured, false otherwise\r
-                */\r
-               bool MIDI_Device_ConfigureEndpoints(USB_ClassInfo_MIDI_t* MIDIInterfaceInfo);\r
-               \r
-               /** Processes incomming control requests from the host, that are directed to the given MIDI class interface. This should be\r
-                *  linked to the library \ref EVENT_USB_UnhandledControlPacket() event.\r
-                *\r
-                *  \param MIDIInterfaceInfo  Pointer to a structure containing a MIDI Class configuration and state.\r
-                */             \r
-               void MIDI_Device_ProcessControlPacket(USB_ClassInfo_MIDI_t* MIDIInterfaceInfo);\r
+       /* Public Interface - May be used in end-application: */\r
+               /* Function Prototypes: */\r
+                       /** Configures the endpoints of a given MIDI interface, ready for use. This should be linked to the library\r
+                        *  \ref EVENT_USB_ConfigurationChanged() event so that the endpoints are configured when the configuration\r
+                        *  containing the given MIDI interface is selected.\r
+                        *\r
+                        *  \param MIDIInterfaceInfo  Pointer to a structure containing a MIDI Class configuration and state.\r
+                        *\r
+                        *  \return Boolean true if the endpoints were sucessfully configured, false otherwise\r
+                        */\r
+                       bool MIDI_Device_ConfigureEndpoints(USB_ClassInfo_MIDI_t* MIDIInterfaceInfo);\r
+                       \r
+                       /** Processes incomming control requests from the host, that are directed to the given MIDI class interface. This should be\r
+                        *  linked to the library \ref EVENT_USB_UnhandledControlPacket() event.\r
+                        *\r
+                        *  \param MIDIInterfaceInfo  Pointer to a structure containing a MIDI Class configuration and state.\r
+                        */             \r
+                       void MIDI_Device_ProcessControlPacket(USB_ClassInfo_MIDI_t* MIDIInterfaceInfo);\r

 \r
 \r

-               /** General management task for a given MIDI class interface, required for the correct operation of the interface. This should\r
-                *  be called frequently in the main program loop, before the master USB management task \ref USB_USBTask().\r
-                *\r
-                *  \param MIDIInterfaceInfo  Pointer to a structure containing a MIDI Class configuration and state.\r
-                */\r
-               void MIDI_Device_USBTask(USB_ClassInfo_MIDI_t* MIDIInterfaceInfo);\r
+                       /** General management task for a given MIDI class interface, required for the correct operation of the interface. This should\r
+                        *  be called frequently in the main program loop, before the master USB management task \ref USB_USBTask().\r
+                        *\r
+                        *  \param MIDIInterfaceInfo  Pointer to a structure containing a MIDI Class configuration and state.\r
+                        */\r
+                       void MIDI_Device_USBTask(USB_ClassInfo_MIDI_t* MIDIInterfaceInfo);\r

 \r
 \r

-               /** Sends a MIDI event packet to the host. If no host is connected, the event packet is discarded.\r
-                *\r
-                *  \param MIDIInterfaceInfo  Pointer to a structure containing a MIDI Class configuration and state.\r
-                *  \param Event  Pointer to a populated USB_MIDI_EventPacket_t structure containing the MIDI event to send\r
-                */\r
-               void MIDI_Device_SendEventPacket(USB_ClassInfo_MIDI_t* MIDIInterfaceInfo, USB_MIDI_EventPacket_t* Event);\r
+                       /** Sends a MIDI event packet to the host. If no host is connected, the event packet is discarded.\r
+                        *\r
+                        *  \param MIDIInterfaceInfo  Pointer to a structure containing a MIDI Class configuration and state.\r
+                        *  \param Event  Pointer to a populated USB_MIDI_EventPacket_t structure containing the MIDI event to send\r
+                        */\r
+                       void MIDI_Device_SendEventPacket(USB_ClassInfo_MIDI_t* MIDIInterfaceInfo, USB_MIDI_EventPacket_t* Event);\r

 \r
 \r

-               /** Receives a MIDI event packet from the host.\r
-                *\r
-                *  \param MIDIInterfaceInfo  Pointer to a structure containing a MIDI Class configuration and state.\r
-                *  \param Event  Pointer to a USB_MIDI_EventPacket_t structure where the received MIDI event is to be placed\r
-                *\r
-                *  \return Boolean true if a MIDI event packet was received, false otherwise\r
-                */\r
-               bool MIDI_Device_ReceiveEventPacket(USB_ClassInfo_MIDI_t* MIDIInterfaceInfo, USB_MIDI_EventPacket_t* Event);\r
+                       /** Receives a MIDI event packet from the host.\r
+                        *\r
+                        *  \param MIDIInterfaceInfo  Pointer to a structure containing a MIDI Class configuration and state.\r
+                        *  \param Event  Pointer to a USB_MIDI_EventPacket_t structure where the received MIDI event is to be placed\r
+                        *\r
+                        *  \return Boolean true if a MIDI event packet was received, false otherwise\r
+                        */\r
+                       bool MIDI_Device_ReceiveEventPacket(USB_ClassInfo_MIDI_t* MIDIInterfaceInfo, USB_MIDI_EventPacket_t* Event);\r

 \r
        /* Disable C linkage for C++ Compilers: */\r
                #if defined(__cplusplus)\r
 \r
        /* Disable C linkage for C++ Compilers: */\r
                #if defined(__cplusplus)\r