diff options
| author | Dean Camera <dean@fourwalledcubicle.com> | 2010-10-12 13:52:06 +0000 |
|---|---|---|
| committer | Dean Camera <dean@fourwalledcubicle.com> | 2010-10-12 13:52:06 +0000 |
| commit | a8871c7fba73307226bd13e2cad4c840c850e6f1 (patch) | |
| tree | f4fbf7ee0d3809592f0ecd0c46b43d3d01b40a51 /LUFA/Drivers/USB/Class/Host/CDC.h | |
| parent | 3693916cd38bd919f07fe45a2f9d19f5f689242f (diff) | |
| download | lufa-a8871c7fba73307226bd13e2cad4c840c850e6f1.tar.gz lufa-a8871c7fba73307226bd13e2cad4c840c850e6f1.tar.bz2 lufa-a8871c7fba73307226bd13e2cad4c840c850e6f1.zip | |
Fixed MIDI_Host_Flush() not aborting early when the specified MIDI host interface was not configured.
Small documentation improvements to explicitly reference tokens in Doxygen, to ensure that they are converted to cross-reference links in the output files.
Diffstat (limited to 'LUFA/Drivers/USB/Class/Host/CDC.h')
| -rw-r--r-- | LUFA/Drivers/USB/Class/Host/CDC.h | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/LUFA/Drivers/USB/Class/Host/CDC.h b/LUFA/Drivers/USB/Class/Host/CDC.h index d7de77b89..e80d01423 100644 --- a/LUFA/Drivers/USB/Class/Host/CDC.h +++ b/LUFA/Drivers/USB/Class/Host/CDC.h @@ -210,7 +210,7 @@ * \ref CDC_Host_Flush() function is called to flush the pending data to the host. This allows for multiple bytes to be * packed into a single pipe packet, increasing data throughput. * - * \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the + * \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the * call will fail. * * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class host configuration and state. @@ -228,7 +228,7 @@ * \ref CDC_Host_Flush() function is called to flush the pending data to the host. This allows for multiple bytes to be * packed into a single pipe packet, increasing data throughput. * - * \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the + * \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the * call will fail. * * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class host configuration and state. @@ -244,7 +244,7 @@ * immediately. If multiple bytes are to be received, they should be buffered by the user application, as the pipe bank will not be * released back to the USB controller until all bytes are read. * - * \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the + * \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the * call will fail. * * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class host configuration and state. @@ -257,7 +257,7 @@ * returns a negative value. The \ref CDC_Host_BytesReceived() function may be queried in advance to determine how many bytes * are currently buffered in the CDC interface's data receive pipe. * - * \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the + * \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the * call will fail. * * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class host configuration and state. @@ -268,7 +268,7 @@ /** Flushes any data waiting to be sent, ensuring that the send buffer is cleared. * - * \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the + * \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the * call will fail. * * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class host configuration and state. |