Minor documentation fixes - change \note entries to \warning where appropriate and remove/update old documentation.

3 files changed, 17 insertions, 19 deletions

diff --git a/LUFA/Drivers/USB/Core/XMEGA/Device_XMEGA.h b/LUFA/Drivers/USB/Core/XMEGA/Device_XMEGA.h
index 3712a7e42..85be0f1bf 100644
--- a/LUFA/Drivers/USB/Core/XMEGA/Device_XMEGA.h
+++ b/LUFA/Drivers/USB/Core/XMEGA/Device_XMEGA.h
@@ -133,11 +133,11 @@
 			 *  Typically, this is implemented so that HID devices (mice, keyboards, etc.) can wake up the
 			 *  host computer when the host has suspended all USB devices to enter a low power state.
 			 *
-			 *  \note This macro should only be used if the device has indicated to the host that it
+			 *  \note This function should only be used if the device has indicated to the host that it
 			 *        supports the Remote Wakeup feature in the device descriptors, and should only be
 			 *        issued if the host is currently allowing remote wakeup events from the device (i.e.,
 			 *        the \ref USB_Device_RemoteWakeupEnabled flag is set). When the \c NO_DEVICE_REMOTE_WAKEUP
-			 *        compile time option is used, this macro is unavailable.
+			 *        compile time option is used, this function is unavailable.
 			 *        \n\n
 			 *
 			 *  \note The USB clock must be running for this function to operate. If the stack is initialized with
@@ -165,7 +165,7 @@
 			 *  \ref EVENT_USB_Device_StartOfFrame() event to fire once per millisecond, synchronized to the USB bus,
 			 *  at the start of each USB frame when enumerated in device mode.
 			 *
-			 *  \note Not available when the \c NO_SOF_EVENTS compile time token is defined.
+			 *  \note This function is not available when the \c NO_SOF_EVENTS compile time token is defined.
 			 */
 			static inline void USB_Device_EnableSOFEvents(void) ATTR_ALWAYS_INLINE;
 			static inline void USB_Device_EnableSOFEvents(void)
@@ -176,7 +176,7 @@
 			/** Disables the device mode Start Of Frame events. When disabled, this stops the firing of the
 			 *  \ref EVENT_USB_Device_StartOfFrame() event when enumerated in device mode.
 			 *
-			 *  \note Not available when the \c NO_SOF_EVENTS compile time token is defined.
+			 *  \note This function is not available when the \c NO_SOF_EVENTS compile time token is defined.
 			 */
 			static inline void USB_Device_DisableSOFEvents(void) ATTR_ALWAYS_INLINE;
 			static inline void USB_Device_DisableSOFEvents(void)
diff --git a/LUFA/Drivers/USB/Core/XMEGA/Endpoint_XMEGA.h b/LUFA/Drivers/USB/Core/XMEGA/Endpoint_XMEGA.h
index 8cea092d0..7828f308a 100644
--- a/LUFA/Drivers/USB/Core/XMEGA/Endpoint_XMEGA.h
+++ b/LUFA/Drivers/USB/Core/XMEGA/Endpoint_XMEGA.h
@@ -170,8 +170,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)
 			 */
@@ -179,8 +179,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)
 			 */
@@ -316,9 +316,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_XMEGA
 			 *
 			 *  \return Total number of bytes in the currently selected Endpoint's FIFO buffer.
@@ -793,8 +790,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;
@@ -806,6 +803,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);
 
diff --git a/LUFA/Drivers/USB/Core/XMEGA/USBController_XMEGA.h b/LUFA/Drivers/USB/Core/XMEGA/USBController_XMEGA.h
index 60f3e127b..2f14f758a 100644
--- a/LUFA/Drivers/USB/Core/XMEGA/USBController_XMEGA.h
+++ b/LUFA/Drivers/USB/Core/XMEGA/USBController_XMEGA.h
@@ -192,7 +192,7 @@
 			 *        function prototype.
 			 *        \n\n
 			 *
-			 *  \note To reduce the FLASH requirements of the library if only fixed settings are are required,
+			 *  \note To reduce the FLASH requirements of the library if only fixed settings are required,
 			 *        the options may be set statically in the same manner as the mode (see the Mode parameter of
 			 *        this function). To statically set the USB options, pass in the \c USE_STATIC_OPTIONS token,
 			 *        defined to the appropriate options masks. When the options are statically set, this
@@ -236,9 +236,8 @@
 				/** Indicates the mode that the USB interface is currently initialized to, a value from the
 				 *  \ref USB_Modes_t enum.
 				 *
-				 *  \note This variable should be treated as read-only in the user application, and never manually
-				 *        changed in value.
-				 *        \n\n
+				 *  \attention This variable should be treated as read-only in the user application, and never manually
+				 *             changed in value.
 				 *
 				 *  \note When the controller is initialized into UID auto-detection mode, this variable will hold the
 				 *        currently selected USB mode (i.e. \ref USB_MODE_Device or \ref USB_MODE_Host). If the controller
@@ -256,8 +255,8 @@
 				/** Indicates the current USB options that the USB interface was initialized with when \ref USB_Init()
 				 *  was called. This value will be one of the \c USB_MODE_* masks defined elsewhere in this module.
 				 *
-				 *  \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.
 				 */
 				extern volatile uint8_t USB_Options;
 			#elif defined(USE_STATIC_OPTIONS)