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/Host/CDC.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/Host/CDC.h')
| -rw-r--r-- | LUFA/Drivers/USB/Class/Host/CDC.h | 20 |
1 files changed, 10 insertions, 10 deletions
diff --git a/LUFA/Drivers/USB/Class/Host/CDC.h b/LUFA/Drivers/USB/Class/Host/CDC.h index 0f8807ed2..ece23c546 100644 --- a/LUFA/Drivers/USB/Class/Host/CDC.h +++ b/LUFA/Drivers/USB/Class/Host/CDC.h @@ -205,8 +205,8 @@ * \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. * - * \note This function must only be called when the Host state machine is in the HOST_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] CDCInterfaceInfo Pointer to a structure containing a CDC Class host configuration and state * \param[in] Data Pointer to the string to send to the device @@ -222,8 +222,8 @@ * \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. * - * \note This function must only be called when the Host state machine is in the HOST_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] CDCInterfaceInfo Pointer to a structure containing a CDC Class host configuration and state * \param[in] Data Byte of data to send to the device @@ -234,8 +234,8 @@ /** Determines the number of bytes received by the CDC interface from the device, waiting to be read. * - * \note This function must only be called when the Host state machine is in the HOST_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] CDCInterfaceInfo Pointer to a structure containing a CDC Class host configuration and state * @@ -247,8 +247,8 @@ * returns 0. The \ref CDC_Host_BytesReceived() function should be queried before data is received to ensure that no data * underflow occurs. * - * \note This function must only be called when the Host state machine is in the HOST_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] CDCInterfaceInfo Pointer to a structure containing a CDC Class host configuration and state * @@ -258,8 +258,8 @@ /** Flushes any data waiting to be sent, ensuring that the send buffer is cleared. * - * \note This function must only be called when the Host state machine is in the HOST_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] CDCInterfaceInfo Pointer to a structure containing a CDC Class host configuration and state * |