Commit ff00644c authored by Dean Camera's avatar Dean Camera
Browse files

Minor documentation corrections.

parent 9eef78d2
...@@ -339,8 +339,9 @@ ...@@ -339,8 +339,9 @@
* in both failure and success states; the user is responsible for manually clearing the status OUT packet * 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. * 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 * \note This function automatically sends the last packet in the data stage of the transaction; when the
* to clear the status stage when using this routine in a control transaction. * 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 * \n\n
* *
* \note This routine should only be used on CONTROL type endpoints. * \note This routine should only be used on CONTROL type endpoints.
...@@ -361,8 +362,9 @@ ...@@ -361,8 +362,9 @@
* in both failure and success states; the user is responsible for manually clearing the status OUT packet * 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. * 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 * \note This function automatically sends the last packet in the data stage of the transaction; when the
* to clear the status stage when using this routine in a control transaction. * 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 * \n\n
* *
* \note This routine should only be used on CONTROL type endpoints. * \note This routine should only be used on CONTROL type endpoints.
...@@ -383,8 +385,9 @@ ...@@ -383,8 +385,9 @@
* automatically sent after success or failure states; the user is responsible for manually sending the * 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. * 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 * \note This function automatically sends the last packet in the data stage of the transaction; when the
* to clear the status stage when using this routine in a control transaction. * 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 * \n\n
* *
* \note This routine should only be used on CONTROL type endpoints. * \note This routine should only be used on CONTROL type endpoints.
...@@ -405,8 +408,9 @@ ...@@ -405,8 +408,9 @@
* automatically sent after success or failure states; the user is responsible for manually sending the * 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. * 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 * \note This function automatically sends the last packet in the data stage of the transaction; when the
* to clear the status stage when using this routine in a control transaction. * 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 * \n\n
* *
* \note This routine should only be used on CONTROL type endpoints. * \note This routine should only be used on CONTROL type endpoints.
...@@ -480,8 +484,9 @@ ...@@ -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 * \note This function automatically sends the last packet in the data stage of the transaction; when the
* to clear the status stage when using this routine in a control transaction. * 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 * \n\n
* *
* \note This routine should only be used on CONTROL type endpoints. * \note This routine should only be used on CONTROL type endpoints.
...@@ -500,8 +505,9 @@ ...@@ -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 * \note This function automatically sends the last packet in the data stage of the transaction; when the
* to clear the status stage when using this routine in a control transaction. * 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 * \n\n
* *
* \note This routine should only be used on CONTROL type endpoints. * \note This routine should only be used on CONTROL type endpoints.
...@@ -520,8 +526,9 @@ ...@@ -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 * \note This function automatically sends the last packet in the data stage of the transaction; when the
* to clear the status stage when using this routine in a control transaction. * 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 * \n\n
* *
* \note This routine should only be used on CONTROL type endpoints. * \note This routine should only be used on CONTROL type endpoints.
...@@ -540,8 +547,9 @@ ...@@ -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 * \note This function automatically sends the last packet in the data stage of the transaction; when the
* to clear the status stage when using this routine in a control transaction. * 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 * \n\n
* *
* \note This routine should only be used on CONTROL type endpoints. * \note This routine should only be used on CONTROL type endpoints.
...@@ -596,8 +604,9 @@ ...@@ -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 * \note This function automatically sends the last packet in the data stage of the transaction; when the
* to clear the status stage when using this routine in a control transaction. * 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 * \n\n
* *
* \note This routine should only be used on CONTROL type endpoints. * \note This routine should only be used on CONTROL type endpoints.
...@@ -618,8 +627,9 @@ ...@@ -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 * \note This function automatically sends the last packet in the data stage of the transaction; when the
* to clear the status stage when using this routine in a control transaction. * 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 * \n\n
* *
* \note This routine should only be used on CONTROL type endpoints. * \note This routine should only be used on CONTROL type endpoints.
......
...@@ -339,8 +339,9 @@ ...@@ -339,8 +339,9 @@
* in both failure and success states; the user is responsible for manually clearing the status OUT packet * 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. * 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 * \note This function automatically sends the last packet in the data stage of the transaction; when the
* to clear the status stage when using this routine in a control transaction. * 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 * \n\n
* *
* \note This routine should only be used on CONTROL type endpoints. * \note This routine should only be used on CONTROL type endpoints.
...@@ -361,8 +362,9 @@ ...@@ -361,8 +362,9 @@
* in both failure and success states; the user is responsible for manually clearing the status OUT packet * 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. * 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 * \note This function automatically sends the last packet in the data stage of the transaction; when the
* to clear the status stage when using this routine in a control transaction. * 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 * \n\n
* *
* \note This routine should only be used on CONTROL type endpoints. * \note This routine should only be used on CONTROL type endpoints.
...@@ -383,8 +385,9 @@ ...@@ -383,8 +385,9 @@
* automatically sent after success or failure states; the user is responsible for manually sending the * 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. * 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 * \note This function automatically sends the last packet in the data stage of the transaction; when the
* to clear the status stage when using this routine in a control transaction. * 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 * \n\n
* *
* \note This routine should only be used on CONTROL type endpoints. * \note This routine should only be used on CONTROL type endpoints.
...@@ -405,8 +408,9 @@ ...@@ -405,8 +408,9 @@
* automatically sent after success or failure states; the user is responsible for manually sending the * 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. * 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 * \note This function automatically sends the last packet in the data stage of the transaction; when the
* to clear the status stage when using this routine in a control transaction. * 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 * \n\n
* *
* \note This routine should only be used on CONTROL type endpoints. * \note This routine should only be used on CONTROL type endpoints.
......
...@@ -339,8 +339,9 @@ ...@@ -339,8 +339,9 @@
* in both failure and success states; the user is responsible for manually clearing the status OUT packet * 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. * 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 * \note This function automatically sends the last packet in the data stage of the transaction; when the
* to clear the status stage when using this routine in a control transaction. * 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 * \n\n
* *
* \note This routine should only be used on CONTROL type endpoints. * \note This routine should only be used on CONTROL type endpoints.
...@@ -361,8 +362,9 @@ ...@@ -361,8 +362,9 @@
* in both failure and success states; the user is responsible for manually clearing the status OUT packet * 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. * 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 * \note This function automatically sends the last packet in the data stage of the transaction; when the
* to clear the status stage when using this routine in a control transaction. * 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 * \n\n
* *
* \note This routine should only be used on CONTROL type endpoints. * \note This routine should only be used on CONTROL type endpoints.
...@@ -383,8 +385,9 @@ ...@@ -383,8 +385,9 @@
* automatically sent after success or failure states; the user is responsible for manually sending the * 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. * 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 * \note This function automatically sends the last packet in the data stage of the transaction; when the
* to clear the status stage when using this routine in a control transaction. * 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 * \n\n
* *
* \note This routine should only be used on CONTROL type endpoints. * \note This routine should only be used on CONTROL type endpoints.
...@@ -405,8 +408,9 @@ ...@@ -405,8 +408,9 @@
* automatically sent after success or failure states; the user is responsible for manually sending the * 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. * 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 * \note This function automatically sends the last packet in the data stage of the transaction; when the
* to clear the status stage when using this routine in a control transaction. * 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 * \n\n
* *
* \note This routine should only be used on CONTROL type endpoints. * \note This routine should only be used on CONTROL type endpoints.
...@@ -480,8 +484,9 @@ ...@@ -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 * \note This function automatically sends the last packet in the data stage of the transaction; when the
* to clear the status stage when using this routine in a control transaction. * 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 * \n\n
* *
* \note This routine should only be used on CONTROL type endpoints. * \note This routine should only be used on CONTROL type endpoints.
...@@ -500,8 +505,9 @@ ...@@ -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 * \note This function automatically sends the last packet in the data stage of the transaction; when the
* to clear the status stage when using this routine in a control transaction. * 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 * \n\n
* *
* \note This routine should only be used on CONTROL type endpoints. * \note This routine should only be used on CONTROL type endpoints.
...@@ -520,8 +526,9 @@ ...@@ -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 * \note This function automatically sends the last packet in the data stage of the transaction; when the
* to clear the status stage when using this routine in a control transaction. * 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 * \n\n
* *
* \note This routine should only be used on CONTROL type endpoints. * \note This routine should only be used on CONTROL type endpoints.
...@@ -540,8 +547,9 @@ ...@@ -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 * \note This function automatically sends the last packet in the data stage of the transaction; when the
* to clear the status stage when using this routine in a control transaction. * 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 * \n\n
* *
* \note This routine should only be used on CONTROL type endpoints. * \note This routine should only be used on CONTROL type endpoints.
...@@ -596,8 +604,9 @@ ...@@ -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 * \note This function automatically sends the last packet in the data stage of the transaction; when the
* to clear the status stage when using this routine in a control transaction. * 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 * \n\n
* *
* \note This routine should only be used on CONTROL type endpoints. * \note This routine should only be used on CONTROL type endpoints.
...@@ -618,8 +627,9 @@ ...@@ -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 * \note This function automatically sends the last packet in the data stage of the transaction; when the
* to clear the status stage when using this routine in a control transaction. * 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 * \n\n
* *
* \note This routine should only be used on CONTROL type endpoints. * \note This routine should only be used on CONTROL type endpoints.
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment