Minor documentation fixes - change \note entries to \warning where appropriate and...

[pub/lufa.git] / LUFA / Drivers / USB / Core / AVR8 / Endpoint_AVR8.h

diff --git a/LUFA/Drivers/USB/Core/AVR8/Endpoint_AVR8.h b/LUFA/Drivers/USB/Core/AVR8/Endpoint_AVR8.h
index 066fc3d..10f69a8 100644 (file)
--- a/LUFA/Drivers/USB/Core/AVR8/Endpoint_AVR8.h
+++ b/LUFA/Drivers/USB/Core/AVR8/Endpoint_AVR8.h
@@ -171,8 +171,8 @@
 
                        /** Retrieves the maximum bank size in bytes of a given endpoint.
                         *
-                        *  \note This macro will only work correctly on endpoint indexes that are compile-time constants
-                        *        defined by the preprocessor.
+                        *  \attention This macro will only work correctly on endpoint indexes that are compile-time constants
+                        *             defined by the preprocessor.
                         *
                         *  \param[in] EPIndex  Endpoint number, a value between 0 and (\ref ENDPOINT_TOTAL_ENDPOINTS - 1)
                         */
@@ -180,8 +180,8 @@
 
                        /** Retrieves the total number of banks supported by the given endpoint.
                         *
-                        *  \note This macro will only work correctly on endpoint indexes that are compile-time constants
-                        *        defined by the preprocessor.
+                        *  \attention This macro will only work correctly on endpoint indexes that are compile-time constants
+                        *             defined by the preprocessor.
                         *
                         *  \param[in] EPIndex  Endpoint number, a value between 0 and (\ref ENDPOINT_TOTAL_ENDPOINTS - 1)
                         */
@@ -245,12 +245,11 @@
                         *                        More banks uses more USB DPRAM, but offers better performance. Isochronous type
                         *                        endpoints <b>must</b> have at least two banks.
                         *
-                        *  \note When the \c ORDERED_EP_CONFIG compile time option is used, Endpoints <b>must</b> be configured in
-                        *        ascending order, or bank corruption will occur.
-                        *        \n\n
+                        *  \attention When the \c ORDERED_EP_CONFIG compile time option is used, Endpoints <b>must</b> be configured in
+                        *             ascending order, or bank corruption will occur.
                         *
-                        *  \note Different endpoints may have different maximum packet sizes based on the endpoint's index - refer to
-                        *        the chosen microcontroller model's datasheet to determine the maximum bank size for each endpoint.
+                        *  \note Different endpoints may have different maximum packet sizes based on the endpoint's index - please
+                        *        refer to the chosen microcontroller model's datasheet to determine the maximum bank size for each endpoint.
                         *        \n\n
                         *
                         *  \note The default control endpoint should not be manually configured by the user application, as
@@ -279,9 +278,6 @@
 
                        /** Indicates the number of bytes currently stored in the current endpoint's selected bank.
                         *
-                        *  \note The return width of this function may differ, depending on the maximum endpoint bank size
-                        *        of the selected AVR model.
-                        *
                         *  \ingroup Group_EndpointRW_AVR8
                         *
                         *  \return Total number of bytes in the currently selected Endpoint's FIFO buffer.
@@ -835,8 +831,8 @@
                         *  \c FIXED_CONTROL_ENDPOINT_SIZE token - it is recommended that the \c FIXED_CONTROL_ENDPOINT_SIZE token
                         *  be used in the device descriptors to ensure this.
                         *
-                        *  \note This variable should be treated as read-only in the user application, and never manually
-                        *        changed in value.
+                        *  \attention This variable should be treated as read-only in the user application, and never manually
+                        *             changed in value.
                         */
                        #if (!defined(FIXED_CONTROL_ENDPOINT_SIZE) || defined(__DOXYGEN__))
                                extern uint8_t USB_Device_ControlEndpointSize;
@@ -848,6 +844,8 @@
                        /** Completes the status stage of a control transfer on a CONTROL type endpoint automatically,
                         *  with respect to the data direction. This is a convenience function which can be used to
                         *  simplify user control request handling.
+                        *
+                        *  \note This routine should not be called on non CONTROL type endpoints.
                         */
                        void Endpoint_ClearStatusStage(void);