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

2 files changed, 13 insertions, 15 deletions

diff --git a/LUFA/Drivers/USB/LowLevel/Endpoint.h b/LUFA/Drivers/USB/LowLevel/Endpoint.h
index 760a37787..60e1018f6 100644
--- a/LUFA/Drivers/USB/LowLevel/Endpoint.h
+++ b/LUFA/Drivers/USB/LowLevel/Endpoint.h
@@ -756,8 +756,8 @@
 			 *
 			 *  The banking mode may be either \ref ENDPOINT_BANK_SINGLE or \ref ENDPOINT_BANK_DOUBLE.
 			 *
-			 *  \note The default control endpoint does not have to be manually configured, as it is automatically
-			 *        configured by the library internally.
+			 *  \note The default control endpoint 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 endpoint, and the endpoint will remain selected
@@ -844,7 +844,7 @@
 
 			/** FLASH buffer source version of \ref Endpoint_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_EndpointStreamRW
 			 *
@@ -893,7 +893,7 @@
 
 			/** FLASH buffer source version of \ref Endpoint_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_EndpointStreamRW
 			 *
@@ -1020,13 +1020,12 @@
 
 			/** FLASH buffer source version of \ref Endpoint_Write_Control_Stream_LE().
 			 *
+			 *  \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.
 			 *        \n\n
 			 *
-			 *  \note The FLASH data must be located in the first 64KB of FLASH for this function to work correctly.
-			 *        \n\n
-			 *
 			 *  \note This routine should only be used on CONTROL type endpoints.
 			 *
 			 *  \warning Unlike the standard stream read/write commands, the control stream commands cannot be chained
@@ -1086,13 +1085,12 @@
 
 			/** FLASH buffer source version of \ref Endpoint_Write_Control_Stream_BE().
 			 *
+			 *  \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.
 			 *        \n\n
 			 *
-			 *  \note The FLASH data must be located in the first 64KB of FLASH for this function to work correctly.
-			 *        \n\n
-			 *
 			 *  \note This routine should only be used on CONTROL type endpoints.
 			 *
 			 *  \warning Unlike the standard stream read/write commands, the control stream commands cannot be chained
diff --git a/LUFA/Drivers/USB/LowLevel/Pipe.h b/LUFA/Drivers/USB/LowLevel/Pipe.h
index b4b40cacf..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
@@ -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
 			 *