Change over Doxygen \note documentation to \pre where applicable.

[pub/USBasp.git] / Demos / Device / ClassDriver / RNDISEthernet / Lib / TCP.h

diff --git a/Demos/Device/ClassDriver/RNDISEthernet/Lib/TCP.h b/Demos/Device/ClassDriver/RNDISEthernet/Lib/TCP.h
index 059f76d..b5152b3 100644 (file)
--- a/Demos/Device/ClassDriver/RNDISEthernet/Lib/TCP.h
+++ b/Demos/Device/ClassDriver/RNDISEthernet/Lib/TCP.h
@@ -102,7 +102,8 @@
                 *  \return Boolean true if the buffer has been captured by the application for device-to-host transmissions, false otherwise
                 */
                #define TCP_APP_HAVE_CAPTURED_BUFFER(Buffer) (!(Buffer->Ready) && Buffer->InUse && \
                 *  \return Boolean true if the buffer has been captured by the application for device-to-host transmissions, false otherwise
                 */
                #define TCP_APP_HAVE_CAPTURED_BUFFER(Buffer) (!(Buffer->Ready) && Buffer->InUse && \

-                                                             (Buffer->Direction == TCP_PACKETDIR_OUT))
+                                  
+                           (Buffer->Direction == TCP_PACKETDIR_OUT))

 
                /** Application macro: Indicates if the application can lock the buffer for multiple continued device-to-host transmissions.
                 *
 
                /** Application macro: Indicates if the application can lock the buffer for multiple continued device-to-host transmissions.
                 *


@@ -115,7 +116,7 @@
                /** Application macro: Captures the application buffer, locking it for device-to-host transmissions only. This should be
                 *  performed when the application needs to transmit several packets worth of data in succession with no interruptions from the host.
                 *
                /** Application macro: Captures the application buffer, locking it for device-to-host transmissions only. This should be
                 *  performed when the application needs to transmit several packets worth of data in succession with no interruptions from the host.
                 *

-                *  \note The application must check that the buffer can be locked first using TCP_APP_CAN_CAPTURE_BUFFER().
+                *  \pre The application must check that the buffer can be locked first using TCP_APP_CAN_CAPTURE_BUFFER().

                 *
                 *  \param[in] Buffer  Application buffer to lock
                 */
                 *
                 *  \param[in] Buffer  Application buffer to lock
                 */