X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/071e02c6b6b4837fa9cf0b6d4c749994e02638d7..69dc32c5f01e8640c1bdf83df3a2a7699ea54560:/LUFA/Drivers/USB/LowLevel/Pipe.h

diff --git a/LUFA/Drivers/USB/LowLevel/Pipe.h b/LUFA/Drivers/USB/LowLevel/Pipe.h
index 02f882dc5..7283fc820 100644
--- a/LUFA/Drivers/USB/LowLevel/Pipe.h
+++ b/LUFA/Drivers/USB/LowLevel/Pipe.h
@@ -231,7 +231,7 @@
 				/** Enables the currently selected pipe so that data can be sent and received through it to and from
 				 *  an attached device.
 				 *
-				 *  \note Pipes must first be configured properly via \ref Pipe_ConfigurePipe().
+				 *  \pre The currently selected pipe must first be configured properly via \ref Pipe_ConfigurePipe().
 				 */
 				static inline void Pipe_EnablePipe(void);
 
@@ -799,8 +799,8 @@
 			 *  numbers of IN requests without automatic freezing - this can be overridden by a call to
 			 *  \ref Pipe_SetFiniteINRequests().
 			 *
-			 *  \note The default control pipe does not have to be manually configured, as it is automatically
-			 *        configured by the library internally.
+			 *  \note The default control pipe should not be manually configured by the user application, as it 
+			 *        is automatically configured by the library internally.
 			 *        \n\n
 			 *
 			 *  \note This routine will select the specified pipe, and the pipe will remain selected once the
@@ -845,7 +845,7 @@
 			 *
 			 *  \ingroup Group_PipeStreamRW
 			 *
-			 *  \param[in] Length  Number of bytes to send via the currently selected pipe.
+			 *  \param[in] Length    Number of bytes to send via the currently selected pipe.
 			 *  \param[in] Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback
 			 *
 			 *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
@@ -889,7 +889,7 @@
 			
 			/** FLASH buffer source version of \ref Pipe_Write_Stream_LE().
 			 *
-			 *  \note 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.
 			 *
 			 *  \ingroup Group_PipeStreamRW
 			 *
@@ -938,7 +938,7 @@
 			
 			/** FLASH buffer source version of \ref Pipe_Write_Stream_BE().
 			 *
-			 *  \note 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.
 			 *
 			 *  \ingroup Group_PipeStreamRW
 			 *
@@ -965,9 +965,9 @@
 			 *
 			 *  \ingroup Group_PipeStreamRW
 			 *
-			 *  \param[out] Buffer   Pointer to the source data buffer to write to.
-			 *  \param[in] Length    Number of bytes to read for the currently selected pipe to read from.
-			 *  \param[in] Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback
+			 *  \param[out] Buffer    Pointer to the source data buffer to write to.
+			 *  \param[in]  Length    Number of bytes to read for the currently selected pipe to read from.
+			 *  \param[in]  Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback
 			 *
 			 *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
 			 */
@@ -977,9 +977,9 @@
 			 *
 			 *  \ingroup Group_PipeStreamRW
 			 *
-			 *  \param[out] Buffer   Pointer to the source data buffer to write to.
-			 *  \param[in] Length    Number of bytes to read for the currently selected pipe to read from.
-			 *  \param[in] Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback
+			 *  \param[out] Buffer    Pointer to the source data buffer to write to.
+			 *  \param[in]  Length    Number of bytes to read for the currently selected pipe to read from.
+			 *  \param[in]  Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback
 			 *
 			 *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
 			 */
@@ -1000,9 +1000,9 @@
 			 *
 			 *  \ingroup Group_PipeStreamRW
 			 *
-			 *  \param[out] Buffer   Pointer to the source data buffer to write to.
-			 *  \param[in] Length    Number of bytes to read for the currently selected pipe to read from.
-			 *  \param[in] Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback
+			 *  \param[out] Buffer    Pointer to the source data buffer to write to.
+			 *  \param[in]  Length    Number of bytes to read for the currently selected pipe to read from.
+			 *  \param[in]  Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback
 			 *
 			 *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
 			 */
@@ -1012,9 +1012,9 @@
 			 *
 			 *  \ingroup Group_PipeStreamRW
 			 *
-			 *  \param[out] Buffer   Pointer to the source data buffer to write to.
-			 *  \param[in] Length    Number of bytes to read for the currently selected pipe to read from.
-			 *  \param[in] Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback
+			 *  \param[out] Buffer    Pointer to the source data buffer to write to.
+			 *  \param[in]  Length    Number of bytes to read for the currently selected pipe to read from.
+			 *  \param[in]  Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback
 			 *
 			 *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
 			 */