X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/8f6b4ddf764c3a54e42d00a7502c82c5c3e71b1c..a908773a13ee491f2f8907cdf57c26fb39e10658:/LUFA/Drivers/USB/LowLevel/Device.h

diff --git a/LUFA/Drivers/USB/LowLevel/Device.h b/LUFA/Drivers/USB/LowLevel/Device.h
index 8a2ee00c3..411ece002 100644
--- a/LUFA/Drivers/USB/LowLevel/Device.h
+++ b/LUFA/Drivers/USB/LowLevel/Device.h
@@ -27,17 +27,12 @@
   arising out of or in connection with the use or performance of
   this software.
 */
-
-/** \file
- *
- *  USB Device mode related macros and enums. This module contains macros and enums which are used when
- *  the USB controller is initialized in device mode.
- */
  
 /** \ingroup Group_USB
  *  @defgroup Group_Device Device Management
  *
- *  Functions, macros, variables, enums and types related to the management of a USB device when in Device mode.
+ *  USB Device mode related macros and enums. This module contains macros and enums which are used when
+ *  the USB controller is initialized in device mode.
  *
  *  @{
  */
@@ -56,7 +51,7 @@
 	/* Public Interface - May be used in end-application: */
 		/* Macros: */
 			#if defined(USB_FULL_CONTROLLER) || defined(USB_MODIFIED_FULL_CONTROLLER) || defined(__DOXYGEN__)
-				/** Mask for the Options parameter of the USB_Init() function. This indicates that the
+				/** Mask for the Options parameter of the \ref USB_Init() function. This indicates that the
 				 *  USB interface should be initialized in low speed (1.5Mb/s) mode.
 				 *
 				 *  \note Low Speed mode is not available on all USB AVR models.
@@ -72,7 +67,7 @@
 			 */
 			#define USB_DEVICE_OPT_FULLSPEED               (0 << 0)
 			
-		/* Psuedo-Function Macros: */
+		/* Pseudo-Function Macros: */
 			#if defined(__DOXYGEN__)
 				/** Sends a Remote Wakeup request to the host. This signals to the host that the device should
 				 *  be taken out of suspended mode, and communications should resume.
@@ -83,30 +78,30 @@
 				 *  \note This macro 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 USB_RemoteWakeupEnabled flag is set, see DevChapter9.h documentation).
+				 *        the \ref USB_RemoteWakeupEnabled flag is set).
 				 *
-				 *  \see StdDescriptors.h for more information on the RMWAKEUP feature and device descriptors.
+				 *  \see \ref Group_Descriptors for more information on the RMWAKEUP feature and device descriptors.
 				 */
 				static inline void USB_Device_SendRemoteWakeup(void);
 				
 				/** Indicates if a Remote Wakeup request is being sent to the host. This returns true if a
 				 *  remote wakeup is currently being sent, false otherwise.
 				 *
-				 *  This can be used in conjunction with the USB_Device_IsUSBSuspended() macro to determine if
+				 *  This can be used in conjunction with the \ref USB_Device_IsUSBSuspended() macro to determine if
 				 *  a sent RMWAKEUP request was accepted or rejected by the host.
 				 *
 				 *  \note This macro should only be used if the device has indicated to the host that it
 				 *        supports the Remote Wakeup feature in the device descriptors.
 				 *
-				 *  \see StdDescriptors.h for more information on the RMWAKEUP feature and device descriptors.
+				 *  \see \ref Group_Descriptors for more information on the RMWAKEUP feature and device descriptors.
 				 *
 				 *  \return Boolean true if no Remote Wakeup request is currently being sent, false otherwise
 				 */
 				static inline bool USB_Device_IsRemoteWakeupSent(void);
 				
-				/** Indicates if the device is currently suspended by the host. While suspended, the device is
-				 *  to enter a low power state until resumed by the host. While suspended no USB traffic to or
-				 *  from the device can occur (except for Remote Wakeup requests).
+				/** Indicates if the device is currently suspended by the host. Whilst suspended, the device is
+				 *  to enter a low power state until resumed by the host. No USB traffic to or from the device
+				 *  can occur (except for Remote Wakeup requests) during suspension by the host.
 				 *
 				 *  \return Boolean true if the USB communications have been suspended by the host, false otherwise.
 				 */
@@ -120,17 +115,17 @@
 			#endif
 
 		/* Enums: */
-			/** Enum for the ErrorCode parameter of the USB_DeviceError event.
+			/** Enum for the ErrorCode parameter of the \ref USB_DeviceError event.
 			 *
 			 *  \see Events.h for more information on this event.
 			 */
 			enum USB_Device_ErrorCodes_t
 			{
-				DEVICE_ERROR_GetDescriptorNotHooked        = 0, /**< Indicates that the GetDescriptor() method
+				DEVICE_ERROR_GetDescriptorNotHooked        = 0, /**< Indicates that the \ref USB_GetDescriptor() method
 				                                                 *   has not been hooked by the user application.
 				                                                 *
-				                                                 *   \see StdDescriptors.h for more information on
-				                                                 *        the GetDescriptor() method.
+				                                                 *   \see \ref Group_Descriptors for more information on
+				                                                 *        the \ref USB_GetDescriptor() method.
 				                                                 */
 			};