diff options
| author | Dean Camera <dean@fourwalledcubicle.com> | 2010-06-15 03:34:55 +0000 |
|---|---|---|
| committer | Dean Camera <dean@fourwalledcubicle.com> | 2010-06-15 03:34:55 +0000 |
| commit | a14ece5f5727e5c8c6b32ed144808ee9ec66ac78 (patch) | |
| tree | 7d3409d0e2b8e0f0958085e2d7c38003ac2ea525 /LUFA/Drivers/USB/Class/Device/MIDI.h | |
| parent | 27fb44268fe72a911441b459098551d12f00ef90 (diff) | |
| download | lufa-a14ece5f5727e5c8c6b32ed144808ee9ec66ac78.tar.gz lufa-a14ece5f5727e5c8c6b32ed144808ee9ec66ac78.tar.bz2 lufa-a14ece5f5727e5c8c6b32ed144808ee9ec66ac78.zip | |
Change over Doxygen \note documentation to \pre where applicable.
Diffstat (limited to 'LUFA/Drivers/USB/Class/Device/MIDI.h')
| -rw-r--r-- | LUFA/Drivers/USB/Class/Device/MIDI.h | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/LUFA/Drivers/USB/Class/Device/MIDI.h b/LUFA/Drivers/USB/Class/Device/MIDI.h index d9b67e275..20a4062bc 100644 --- a/LUFA/Drivers/USB/Class/Device/MIDI.h +++ b/LUFA/Drivers/USB/Class/Device/MIDI.h @@ -116,8 +116,8 @@ * endpoint bank until either the endpoint bank is full, or \ref MIDI_Device_Flush() is called. This allows for multiple * MIDI events to be packed into a single endpoint packet, increasing data throughput. * - * \note This function must only be called when the Device state machine is in the DEVICE_STATE_Configured state or - * the call will fail. + * \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the + * call will fail. * * \param[in,out] MIDIInterfaceInfo Pointer to a structure containing a MIDI Class configuration and state * \param[in] Event Pointer to a populated USB_MIDI_EventPacket_t structure containing the MIDI event to send @@ -140,8 +140,8 @@ /** Receives a MIDI event packet from the host. Events are unpacked from the endpoint, thus if the endpoint bank contains * multiple MIDI events from the host in the one packet, multiple calls to this function will return each individual event. * - * \note This function must only be called when the Device state machine is in the DEVICE_STATE_Configured state or - * the call will fail. + * \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the + * call will fail. * * \param[in,out] MIDIInterfaceInfo Pointer to a structure containing a MIDI Class configuration and state * \param[out] Event Pointer to a USB_MIDI_EventPacket_t structure where the received MIDI event is to be placed |