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

diff --git a/LUFA/Drivers/USB/LowLevel/Host.h b/LUFA/Drivers/USB/LowLevel/Host.h
index 1ff2d7ab2..b1d60afb5 100644
--- a/LUFA/Drivers/USB/LowLevel/Host.h
+++ b/LUFA/Drivers/USB/LowLevel/Host.h
@@ -28,16 +28,11 @@
   this software.
 */
 
-/** \file
- *
- *  USB Host mode related macros and enums. This module contains macros and enums which are used when
- *  the USB controller is initialized in host mode.
- */
-
 /** \ingroup Group_USB
  *  @defgroup Group_Host Host Management
  *
- *  Functions, macros, variables, enums and types related to the management of a USB host when in Host mode.
+ *  USB Host mode related macros and enums. This module contains macros and enums which are used when
+ *  the USB controller is initialized in host mode.
  *
  *  @{
  */
@@ -73,7 +68,7 @@
 				 *  library will return a timeout error code.
 				 *
 				 *  This value may be overridden in the user project makefile as the value of the 
-				 *  USB_HOST_TIMEOUT_MS token, and passed to the compiler using the -D switch.
+				 *  \ref USB_HOST_TIMEOUT_MS token, and passed to the compiler using the -D switch.
 				 */
 				#define USB_HOST_TIMEOUT_MS                1000
 			#endif
@@ -90,7 +85,7 @@
 				#define HOST_DEVICE_SETTLE_DELAY_MS        1500
 			#endif
 		
-		/* Psuedo-Function Macros: */
+		/* Pseudo-Function Macros: */
 			#if defined(__DOXYGEN__)
 				/** Resets the USB bus, including the endpoints in any attached device and pipes on the AVR host.
 				 *  USB bus resets leave the default control pipe configured (if already configured).
@@ -100,7 +95,7 @@
 				 */
 				static inline void USB_Host_ResetBus(void);
 
-				/** Determines if a previously issued bus reset (via the USB_Host_ResetBus() macro) has
+				/** Determines if a previously issued bus reset (via the \ref USB_Host_ResetBus() macro) has
 				 *  completed.
 				 *
 				 *  \return Boolean true if no bus reset is currently being sent, false otherwise.
@@ -119,7 +114,7 @@
 				 */
 				static inline void USB_Host_SuspendBus(void);
 				
-				/** Determines if the USB bus has been suspended via the use of the USB_Host_SuspendBus() macro,
+				/** Determines if the USB bus has been suspended via the use of the \ref USB_Host_SuspendBus() macro,
 				 *  false otherwise. While suspended, no USB communications can occur until the bus is resumed,
 				 *  except for the Remote Wakeup event from the device if supported.
 				 *
@@ -184,8 +179,7 @@
 			 *
 			 *  For information on each state, refer to the USB 2.0 specification. Some states have
 			 *
-			 *  \see USBTask.h for information on the global variable USB_HostState, which stores the
-			 *       current host state machine state.
+			 *  \see \ref USB_HostState, which stores the current host state machine state.
 			 */
 			enum USB_Host_States_t
 			{
@@ -205,28 +199,28 @@
 				HOST_STATE_Suspended                    = 13, /**< May be implemented by the user project. */
 			};
 			
-			/** Enum for the error codes for the USB_HostError event.
+			/** Enum for the error codes for the \ref USB_HostError event.
 			 *
-			 *  \see Events.h for more information on this event.
+			 *  \see \ref Group_Events for more information on this event.
 			 */
 			enum USB_Host_ErrorCodes_t
 			{
 				HOST_ERROR_VBusVoltageDip       = 0, /**< VBUS voltage dipped to an unacceptable level. This
-				                                      *  error may be the result of an attached device drawing
+				                                      *   error may be the result of an attached device drawing
 				                                      *   too much current from the VBUS line, or due to the
 				                                      *   AVR's power source being unable to supply sufficient
 				                                      *   current.
 				                                      */
 			};
 			
-			/** Enum for the error codes for the USB_DeviceEnumerationFailed event.
+			/** Enum for the error codes for the \ref USB_DeviceEnumerationFailed event.
 			 *
-			 *  \see Events.h for more information on this event.
+			 *  \see \ref Group_Events for more information on this event.
 			 */
 			enum USB_Host_EnumerationErrorCodes_t
 			{
 				HOST_ENUMERROR_NoError          = 0, /**< No error occurred. Used internally, this is not a valid
-				                                      *   ErrorCode parameter value for the USB_DeviceEnumerationFailed
+				                                      *   ErrorCode parameter value for the \ref USB_DeviceEnumerationFailed
 				                                      *   event.
 				                                      */
 				HOST_ENUMERROR_WaitStage        = 1, /**< One of the delays between enumeration steps failed