Added const modifiers to device mode class drivers.
[pub/USBasp.git] / Demos / Device / ClassDriver / RNDISEthernet / Lib / TCP.h
index 919245a..b7c991e 100644 (file)
@@ -89,7 +89,7 @@
                \r
                /** Application macro: Determines if the given application buffer contains a packet received from the host\r
                 *\r
-                *  \param Buffer  Application buffer to check\r
+                *  \param[in] Buffer  Application buffer to check\r
                 *\r
                 *  \return Boolean true if the buffer contains a packet from the host, false otherwise\r
                 */\r
@@ -97,7 +97,7 @@
 \r
                /** Application macro: Indicates if the application buffer is currently locked by the application for device-to-host transfers.\r
                 *\r
-                *  \param Buffer  Application buffer to check\r
+                *  \param[in] Buffer  Application buffer to check\r
                 *\r
                 *  \return Boolean true if the buffer has been captured by the application for device-to-host transmissions, false otherwise\r
                 */\r
 \r
                /** Application macro: Indicates if the application can lock the buffer for multiple continued device-to-host transmissions.\r
                 *\r
-                *  \param Buffer  Application buffer to check\r
+                *  \param[in] Buffer  Application buffer to check\r
                 *\r
                 *  \return Boolean true if the buffer may be captured by the application for device-to-host transmissions, false otherwise\r
                 */\r
                 *\r
                 *  \note The application must check that the buffer can be locked first using TCP_APP_CAN_CAPTURE_BUFFER().\r
                 *\r
-                *  \param Buffer  Application buffer to lock\r
+                *  \param[in] Buffer  Application buffer to lock\r
                 */\r
                #define TCP_APP_CAPTURE_BUFFER(Buffer)       MACROS{ Buffer->Direction = TCP_PACKETDIR_OUT; Buffer->InUse = true; }MACROE\r
 \r
                /** Application macro: Releases a captured application buffer, allowing for host-to-device packets to be received.\r
                 *\r
-                *  \param Buffer  Application buffer to release\r
+                *  \param[in] Buffer  Application buffer to release\r
                 */\r
                #define TCP_APP_RELEASE_BUFFER(Buffer)       MACROS{ Buffer->InUse = false; }MACROE\r
 \r
                /** Application macro: Sends the contents of the given application buffer to the host.\r
                 *\r
-                *  \param Buffer  Application buffer to send\r
-                *  \param Len     Length of data contained in the buffer\r
+                *  \param[in] Buffer  Application buffer to send\r
+                *  \param[in] Len     Length of data contained in the buffer\r
                 */\r
                #define TCP_APP_SEND_BUFFER(Buffer, Len)     MACROS{ Buffer->Direction = TCP_PACKETDIR_OUT; Buffer->Length = Len; Buffer->Ready = true; }MACROE\r
 \r
                /** Application macro: Clears the application buffer, ready for a packet to be written to it.\r
                 *\r
-                *  \param Buffer  Application buffer to clear\r
+                *  \param[in] Buffer  Application buffer to clear\r
                 */\r
                #define TCP_APP_CLEAR_BUFFER(Buffer)         MACROS{ Buffer->Ready = false; Buffer->Length = 0; }MACROE\r
                \r
                /** Application macro: Closes an open connection to a host.\r
                 *\r
-                *  \param Connection  Open TCP connection to close\r
+                *  \param[in] Connection  Open TCP connection to close\r
                 */\r
                #define TCP_APP_CLOSECONNECTION(Connection)  MACROS{ Connection->State = TCP_Connection_Closing;  }MACROE\r
 \r