Minor documentation corrections.

diff --git a/LUFA/Drivers/USB/Core/AVR8/EndpointStream_AVR8.h b/LUFA/Drivers/USB/Core/AVR8/EndpointStream_AVR8.h
index eb1f928..9cd8d58 100644 (file)
--- a/LUFA/Drivers/USB/Core/AVR8/EndpointStream_AVR8.h
+++ b/LUFA/Drivers/USB/Core/AVR8/EndpointStream_AVR8.h
@@ -339,8 +339,9 @@
                         *  in both failure and success states; the user is responsible for manually clearing the status OUT packet
                         *  to finalize the transfer's status stage via the \ref Endpoint_ClearOUT() macro.
                         *
                         *  in both failure and success states; the user is responsible for manually clearing the status OUT packet
                         *  to finalize the transfer's status stage via the \ref Endpoint_ClearOUT() macro.
                         *

-                        *  \note This function automatically clears the control transfer's status stage. Do not manually attempt
-                        *        to clear the status stage when using this routine in a control transaction.
+                        *  \note This function automatically sends the last packet in the data stage of the transaction; when the
+                        *        function returns, the user is responsible for clearing the <b>status</b> stage of the transaction.
+                        *        Note that the status stage packet is sent or received in the opposite direction of the data flow.

                         *        \n\n
                         *
                         *  \note This routine should only be used on CONTROL type endpoints.
                         *        \n\n
                         *
                         *  \note This routine should only be used on CONTROL type endpoints.


@@ -361,8 +362,9 @@
                         *  in both failure and success states; the user is responsible for manually clearing the status OUT packet
                         *  to finalize the transfer's status stage via the \ref Endpoint_ClearOUT() macro.
                         *
                         *  in both failure and success states; the user is responsible for manually clearing the status OUT packet
                         *  to finalize the transfer's status stage via the \ref Endpoint_ClearOUT() macro.
                         *

-                        *  \note This function automatically clears the control transfer's status stage. Do not manually attempt
-                        *        to clear the status stage when using this routine in a control transaction.
+                        *  \note This function automatically sends the last packet in the data stage of the transaction; when the
+                        *        function returns, the user is responsible for clearing the <b>status</b> stage of the transaction.
+                        *        Note that the status stage packet is sent or received in the opposite direction of the data flow.

                         *        \n\n
                         *
                         *  \note This routine should only be used on CONTROL type endpoints.
                         *        \n\n
                         *
                         *  \note This routine should only be used on CONTROL type endpoints.


@@ -383,8 +385,9 @@
                         *  automatically sent after success or failure states; the user is responsible for manually sending the
                         *  status IN packet to finalize the transfer's status stage via the \ref Endpoint_ClearIN() macro.
                         *
                         *  automatically sent after success or failure states; the user is responsible for manually sending the
                         *  status IN packet to finalize the transfer's status stage via the \ref Endpoint_ClearIN() macro.
                         *

-                        *  \note This function automatically clears the control transfer's status stage. Do not manually attempt
-                        *        to clear the status stage when using this routine in a control transaction.
+                        *  \note This function automatically sends the last packet in the data stage of the transaction; when the
+                        *        function returns, the user is responsible for clearing the <b>status</b> stage of the transaction.
+                        *        Note that the status stage packet is sent or received in the opposite direction of the data flow.

                         *        \n\n
                         *
                         *  \note This routine should only be used on CONTROL type endpoints.
                         *        \n\n
                         *
                         *  \note This routine should only be used on CONTROL type endpoints.


@@ -405,8 +408,9 @@
                         *  automatically sent after success or failure states; the user is responsible for manually sending the
                         *  status IN packet to finalize the transfer's status stage via the \ref Endpoint_ClearIN() macro.
                         *
                         *  automatically sent after success or failure states; the user is responsible for manually sending the
                         *  status IN packet to finalize the transfer's status stage via the \ref Endpoint_ClearIN() macro.
                         *

-                        *  \note This function automatically clears the control transfer's status stage. Do not manually attempt
-                        *        to clear the status stage when using this routine in a control transaction.
+                        *  \note This function automatically sends the last packet in the data stage of the transaction; when the
+                        *        function returns, the user is responsible for clearing the <b>status</b> stage of the transaction.
+                        *        Note that the status stage packet is sent or received in the opposite direction of the data flow.

                         *        \n\n
                         *
                         *  \note This routine should only be used on CONTROL type endpoints.
                         *        \n\n
                         *
                         *  \note This routine should only be used on CONTROL type endpoints.


@@ -480,8 +484,9 @@
 
                        /** EEPROM buffer source version of Endpoint_Write_Control_Stream_LE.
                         *
 
                        /** EEPROM buffer source version of Endpoint_Write_Control_Stream_LE.
                         *

-                        *  \note This function automatically clears the control transfer's status stage. Do not manually attempt
-                        *        to clear the status stage when using this routine in a control transaction.
+                        *  \note This function automatically sends the last packet in the data stage of the transaction; when the
+                        *        function returns, the user is responsible for clearing the <b>status</b> stage of the transaction.
+                        *        Note that the status stage packet is sent or received in the opposite direction of the data flow.

                         *        \n\n
                         *
                         *  \note This routine should only be used on CONTROL type endpoints.
                         *        \n\n
                         *
                         *  \note This routine should only be used on CONTROL type endpoints.


@@ -500,8 +505,9 @@
 
                        /** EEPROM buffer source version of \ref Endpoint_Write_Control_Stream_BE().
                         *
 
                        /** EEPROM buffer source version of \ref Endpoint_Write_Control_Stream_BE().
                         *

-                        *  \note This function automatically clears the control transfer's status stage. Do not manually attempt
-                        *        to clear the status stage when using this routine in a control transaction.
+                        *  \note This function automatically sends the last packet in the data stage of the transaction; when the
+                        *        function returns, the user is responsible for clearing the <b>status</b> stage of the transaction.
+                        *        Note that the status stage packet is sent or received in the opposite direction of the data flow.

                         *        \n\n
                         *
                         *  \note This routine should only be used on CONTROL type endpoints.
                         *        \n\n
                         *
                         *  \note This routine should only be used on CONTROL type endpoints.


@@ -520,8 +526,9 @@
 
                        /** EEPROM buffer source version of \ref Endpoint_Read_Control_Stream_LE().
                         *
 
                        /** EEPROM buffer source version of \ref Endpoint_Read_Control_Stream_LE().
                         *

-                        *  \note This function automatically clears the control transfer's status stage. Do not manually attempt
-                        *        to clear the status stage when using this routine in a control transaction.
+                        *  \note This function automatically sends the last packet in the data stage of the transaction; when the
+                        *        function returns, the user is responsible for clearing the <b>status</b> stage of the transaction.
+                        *        Note that the status stage packet is sent or received in the opposite direction of the data flow.

                         *        \n\n
                         *
                         *  \note This routine should only be used on CONTROL type endpoints.
                         *        \n\n
                         *
                         *  \note This routine should only be used on CONTROL type endpoints.


@@ -540,8 +547,9 @@
 
                        /** EEPROM buffer source version of \ref Endpoint_Read_Control_Stream_BE().
                         *
 
                        /** EEPROM buffer source version of \ref Endpoint_Read_Control_Stream_BE().
                         *

-                        *  \note This function automatically clears the control transfer's status stage. Do not manually attempt
-                        *        to clear the status stage when using this routine in a control transaction.
+                        *  \note This function automatically sends the last packet in the data stage of the transaction; when the
+                        *        function returns, the user is responsible for clearing the <b>status</b> stage of the transaction.
+                        *        Note that the status stage packet is sent or received in the opposite direction of the data flow.

                         *        \n\n
                         *
                         *  \note This routine should only be used on CONTROL type endpoints.
                         *        \n\n
                         *
                         *  \note This routine should only be used on CONTROL type endpoints.


@@ -596,8 +604,9 @@
                         *
                         *  \pre The FLASH data must be located in the first 64KB of FLASH for this function to work correctly.
                         *
                         *
                         *  \pre The FLASH data must be located in the first 64KB of FLASH for this function to work correctly.
                         *

-                        *  \note This function automatically clears the control transfer's status stage. Do not manually attempt
-                        *        to clear the status stage when using this routine in a control transaction.
+                        *  \note This function automatically sends the last packet in the data stage of the transaction; when the
+                        *        function returns, the user is responsible for clearing the <b>status</b> stage of the transaction.
+                        *        Note that the status stage packet is sent or received in the opposite direction of the data flow.

                         *        \n\n
                         *
                         *  \note This routine should only be used on CONTROL type endpoints.
                         *        \n\n
                         *
                         *  \note This routine should only be used on CONTROL type endpoints.


@@ -618,8 +627,9 @@
                         *
                         *  \pre The FLASH data must be located in the first 64KB of FLASH for this function to work correctly.
                         *
                         *
                         *  \pre The FLASH data must be located in the first 64KB of FLASH for this function to work correctly.
                         *

-                        *  \note This function automatically clears the control transfer's status stage. Do not manually attempt
-                        *        to clear the status stage when using this routine in a control transaction.
+                        *  \note This function automatically sends the last packet in the data stage of the transaction; when the
+                        *        function returns, the user is responsible for clearing the <b>status</b> stage of the transaction.
+                        *        Note that the status stage packet is sent or received in the opposite direction of the data flow.

                         *        \n\n
                         *
                         *  \note This routine should only be used on CONTROL type endpoints.
                         *        \n\n
                         *
                         *  \note This routine should only be used on CONTROL type endpoints.

diff --git a/LUFA/Drivers/USB/Core/UC3/EndpointStream_UC3.h b/LUFA/Drivers/USB/Core/UC3/EndpointStream_UC3.h
index 551cf4b..9a0d06b 100644 (file)
--- a/LUFA/Drivers/USB/Core/UC3/EndpointStream_UC3.h
+++ b/LUFA/Drivers/USB/Core/UC3/EndpointStream_UC3.h
@@ -339,8 +339,9 @@
                         *  in both failure and success states; the user is responsible for manually clearing the status OUT packet
                         *  to finalize the transfer's status stage via the \ref Endpoint_ClearOUT() macro.
                         *
                         *  in both failure and success states; the user is responsible for manually clearing the status OUT packet
                         *  to finalize the transfer's status stage via the \ref Endpoint_ClearOUT() macro.
                         *

-                        *  \note This function automatically clears the control transfer's status stage. Do not manually attempt
-                        *        to clear the status stage when using this routine in a control transaction.
+                        *  \note This function automatically sends the last packet in the data stage of the transaction; when the
+                        *        function returns, the user is responsible for clearing the <b>status</b> stage of the transaction.
+                        *        Note that the status stage packet is sent or received in the opposite direction of the data flow.

                         *        \n\n
                         *
                         *  \note This routine should only be used on CONTROL type endpoints.
                         *        \n\n
                         *
                         *  \note This routine should only be used on CONTROL type endpoints.


@@ -361,8 +362,9 @@
                         *  in both failure and success states; the user is responsible for manually clearing the status OUT packet
                         *  to finalize the transfer's status stage via the \ref Endpoint_ClearOUT() macro.
                         *
                         *  in both failure and success states; the user is responsible for manually clearing the status OUT packet
                         *  to finalize the transfer's status stage via the \ref Endpoint_ClearOUT() macro.
                         *

-                        *  \note This function automatically clears the control transfer's status stage. Do not manually attempt
-                        *        to clear the status stage when using this routine in a control transaction.
+                        *  \note This function automatically sends the last packet in the data stage of the transaction; when the
+                        *        function returns, the user is responsible for clearing the <b>status</b> stage of the transaction.
+                        *        Note that the status stage packet is sent or received in the opposite direction of the data flow.

                         *        \n\n
                         *
                         *  \note This routine should only be used on CONTROL type endpoints.
                         *        \n\n
                         *
                         *  \note This routine should only be used on CONTROL type endpoints.


@@ -383,8 +385,9 @@
                         *  automatically sent after success or failure states; the user is responsible for manually sending the
                         *  status IN packet to finalize the transfer's status stage via the \ref Endpoint_ClearIN() macro.
                         *
                         *  automatically sent after success or failure states; the user is responsible for manually sending the
                         *  status IN packet to finalize the transfer's status stage via the \ref Endpoint_ClearIN() macro.
                         *

-                        *  \note This function automatically clears the control transfer's status stage. Do not manually attempt
-                        *        to clear the status stage when using this routine in a control transaction.
+                        *  \note This function automatically sends the last packet in the data stage of the transaction; when the
+                        *        function returns, the user is responsible for clearing the <b>status</b> stage of the transaction.
+                        *        Note that the status stage packet is sent or received in the opposite direction of the data flow.

                         *        \n\n
                         *
                         *  \note This routine should only be used on CONTROL type endpoints.
                         *        \n\n
                         *
                         *  \note This routine should only be used on CONTROL type endpoints.


@@ -405,8 +408,9 @@
                         *  automatically sent after success or failure states; the user is responsible for manually sending the
                         *  status IN packet to finalize the transfer's status stage via the \ref Endpoint_ClearIN() macro.
                         *
                         *  automatically sent after success or failure states; the user is responsible for manually sending the
                         *  status IN packet to finalize the transfer's status stage via the \ref Endpoint_ClearIN() macro.
                         *

-                        *  \note This function automatically clears the control transfer's status stage. Do not manually attempt
-                        *        to clear the status stage when using this routine in a control transaction.
+                        *  \note This function automatically sends the last packet in the data stage of the transaction; when the
+                        *        function returns, the user is responsible for clearing the <b>status</b> stage of the transaction.
+                        *        Note that the status stage packet is sent or received in the opposite direction of the data flow.

                         *        \n\n
                         *
                         *  \note This routine should only be used on CONTROL type endpoints.
                         *        \n\n
                         *
                         *  \note This routine should only be used on CONTROL type endpoints.

diff --git a/LUFA/Drivers/USB/Core/XMEGA/EndpointStream_XMEGA.h b/LUFA/Drivers/USB/Core/XMEGA/EndpointStream_XMEGA.h
index f2fe289..211f335 100644 (file)
--- a/LUFA/Drivers/USB/Core/XMEGA/EndpointStream_XMEGA.h
+++ b/LUFA/Drivers/USB/Core/XMEGA/EndpointStream_XMEGA.h
@@ -339,8 +339,9 @@
                         *  in both failure and success states; the user is responsible for manually clearing the status OUT packet
                         *  to finalize the transfer's status stage via the \ref Endpoint_ClearOUT() macro.
                         *
                         *  in both failure and success states; the user is responsible for manually clearing the status OUT packet
                         *  to finalize the transfer's status stage via the \ref Endpoint_ClearOUT() macro.
                         *

-                        *  \note This function automatically clears the control transfer's status stage. Do not manually attempt
-                        *        to clear the status stage when using this routine in a control transaction.
+                        *  \note This function automatically sends the last packet in the data stage of the transaction; when the
+                        *        function returns, the user is responsible for clearing the <b>status</b> stage of the transaction.
+                        *        Note that the status stage packet is sent or received in the opposite direction of the data flow.

                         *        \n\n
                         *
                         *  \note This routine should only be used on CONTROL type endpoints.
                         *        \n\n
                         *
                         *  \note This routine should only be used on CONTROL type endpoints.


@@ -361,8 +362,9 @@
                         *  in both failure and success states; the user is responsible for manually clearing the status OUT packet
                         *  to finalize the transfer's status stage via the \ref Endpoint_ClearOUT() macro.
                         *
                         *  in both failure and success states; the user is responsible for manually clearing the status OUT packet
                         *  to finalize the transfer's status stage via the \ref Endpoint_ClearOUT() macro.
                         *

-                        *  \note This function automatically clears the control transfer's status stage. Do not manually attempt
-                        *        to clear the status stage when using this routine in a control transaction.
+                        *  \note This function automatically sends the last packet in the data stage of the transaction; when the
+                        *        function returns, the user is responsible for clearing the <b>status</b> stage of the transaction.
+                        *        Note that the status stage packet is sent or received in the opposite direction of the data flow.

                         *        \n\n
                         *
                         *  \note This routine should only be used on CONTROL type endpoints.
                         *        \n\n
                         *
                         *  \note This routine should only be used on CONTROL type endpoints.


@@ -383,8 +385,9 @@
                         *  automatically sent after success or failure states; the user is responsible for manually sending the
                         *  status IN packet to finalize the transfer's status stage via the \ref Endpoint_ClearIN() macro.
                         *
                         *  automatically sent after success or failure states; the user is responsible for manually sending the
                         *  status IN packet to finalize the transfer's status stage via the \ref Endpoint_ClearIN() macro.
                         *

-                        *  \note This function automatically clears the control transfer's status stage. Do not manually attempt
-                        *        to clear the status stage when using this routine in a control transaction.
+                        *  \note This function automatically sends the last packet in the data stage of the transaction; when the
+                        *        function returns, the user is responsible for clearing the <b>status</b> stage of the transaction.
+                        *        Note that the status stage packet is sent or received in the opposite direction of the data flow.

                         *        \n\n
                         *
                         *  \note This routine should only be used on CONTROL type endpoints.
                         *        \n\n
                         *
                         *  \note This routine should only be used on CONTROL type endpoints.


@@ -405,8 +408,9 @@
                         *  automatically sent after success or failure states; the user is responsible for manually sending the
                         *  status IN packet to finalize the transfer's status stage via the \ref Endpoint_ClearIN() macro.
                         *
                         *  automatically sent after success or failure states; the user is responsible for manually sending the
                         *  status IN packet to finalize the transfer's status stage via the \ref Endpoint_ClearIN() macro.
                         *

-                        *  \note This function automatically clears the control transfer's status stage. Do not manually attempt
-                        *        to clear the status stage when using this routine in a control transaction.
+                        *  \note This function automatically sends the last packet in the data stage of the transaction; when the
+                        *        function returns, the user is responsible for clearing the <b>status</b> stage of the transaction.
+                        *        Note that the status stage packet is sent or received in the opposite direction of the data flow.

                         *        \n\n
                         *
                         *  \note This routine should only be used on CONTROL type endpoints.
                         *        \n\n
                         *
                         *  \note This routine should only be used on CONTROL type endpoints.


@@ -480,8 +484,9 @@
 
                        /** EEPROM buffer source version of Endpoint_Write_Control_Stream_LE.
                         *
 
                        /** EEPROM buffer source version of Endpoint_Write_Control_Stream_LE.
                         *

-                        *  \note This function automatically clears the control transfer's status stage. Do not manually attempt
-                        *        to clear the status stage when using this routine in a control transaction.
+                        *  \note This function automatically sends the last packet in the data stage of the transaction; when the
+                        *        function returns, the user is responsible for clearing the <b>status</b> stage of the transaction.
+                        *        Note that the status stage packet is sent or received in the opposite direction of the data flow.

                         *        \n\n
                         *
                         *  \note This routine should only be used on CONTROL type endpoints.
                         *        \n\n
                         *
                         *  \note This routine should only be used on CONTROL type endpoints.


@@ -500,8 +505,9 @@
 
                        /** EEPROM buffer source version of \ref Endpoint_Write_Control_Stream_BE().
                         *
 
                        /** EEPROM buffer source version of \ref Endpoint_Write_Control_Stream_BE().
                         *

-                        *  \note This function automatically clears the control transfer's status stage. Do not manually attempt
-                        *        to clear the status stage when using this routine in a control transaction.
+                        *  \note This function automatically sends the last packet in the data stage of the transaction; when the
+                        *        function returns, the user is responsible for clearing the <b>status</b> stage of the transaction.
+                        *        Note that the status stage packet is sent or received in the opposite direction of the data flow.

                         *        \n\n
                         *
                         *  \note This routine should only be used on CONTROL type endpoints.
                         *        \n\n
                         *
                         *  \note This routine should only be used on CONTROL type endpoints.


@@ -520,8 +526,9 @@
 
                        /** EEPROM buffer source version of \ref Endpoint_Read_Control_Stream_LE().
                         *
 
                        /** EEPROM buffer source version of \ref Endpoint_Read_Control_Stream_LE().
                         *

-                        *  \note This function automatically clears the control transfer's status stage. Do not manually attempt
-                        *        to clear the status stage when using this routine in a control transaction.
+                        *  \note This function automatically sends the last packet in the data stage of the transaction; when the
+                        *        function returns, the user is responsible for clearing the <b>status</b> stage of the transaction.
+                        *        Note that the status stage packet is sent or received in the opposite direction of the data flow.

                         *        \n\n
                         *
                         *  \note This routine should only be used on CONTROL type endpoints.
                         *        \n\n
                         *
                         *  \note This routine should only be used on CONTROL type endpoints.


@@ -540,8 +547,9 @@
 
                        /** EEPROM buffer source version of \ref Endpoint_Read_Control_Stream_BE().
                         *
 
                        /** EEPROM buffer source version of \ref Endpoint_Read_Control_Stream_BE().
                         *

-                        *  \note This function automatically clears the control transfer's status stage. Do not manually attempt
-                        *        to clear the status stage when using this routine in a control transaction.
+                        *  \note This function automatically sends the last packet in the data stage of the transaction; when the
+                        *        function returns, the user is responsible for clearing the <b>status</b> stage of the transaction.
+                        *        Note that the status stage packet is sent or received in the opposite direction of the data flow.

                         *        \n\n
                         *
                         *  \note This routine should only be used on CONTROL type endpoints.
                         *        \n\n
                         *
                         *  \note This routine should only be used on CONTROL type endpoints.


@@ -596,8 +604,9 @@
                         *
                         *  \pre The FLASH data must be located in the first 64KB of FLASH for this function to work correctly.
                         *
                         *
                         *  \pre The FLASH data must be located in the first 64KB of FLASH for this function to work correctly.
                         *

-                        *  \note This function automatically clears the control transfer's status stage. Do not manually attempt
-                        *        to clear the status stage when using this routine in a control transaction.
+                        *  \note This function automatically sends the last packet in the data stage of the transaction; when the
+                        *        function returns, the user is responsible for clearing the <b>status</b> stage of the transaction.
+                        *        Note that the status stage packet is sent or received in the opposite direction of the data flow.

                         *        \n\n
                         *
                         *  \note This routine should only be used on CONTROL type endpoints.
                         *        \n\n
                         *
                         *  \note This routine should only be used on CONTROL type endpoints.


@@ -618,8 +627,9 @@
                         *
                         *  \pre The FLASH data must be located in the first 64KB of FLASH for this function to work correctly.
                         *
                         *
                         *  \pre The FLASH data must be located in the first 64KB of FLASH for this function to work correctly.
                         *

-                        *  \note This function automatically clears the control transfer's status stage. Do not manually attempt
-                        *        to clear the status stage when using this routine in a control transaction.
+                        *  \note This function automatically sends the last packet in the data stage of the transaction; when the
+                        *        function returns, the user is responsible for clearing the <b>status</b> stage of the transaction.
+                        *        Note that the status stage packet is sent or received in the opposite direction of the data flow.

                         *        \n\n
                         *
                         *  \note This routine should only be used on CONTROL type endpoints.
                         *        \n\n
                         *
                         *  \note This routine should only be used on CONTROL type endpoints.