X-Git-Url: http://git.linex4red.de/pub/lufa.git/blobdiff_plain/8f6b4ddf764c3a54e42d00a7502c82c5c3e71b1c..a504a3a010ec2441dda0209f195492fb36e7c97b:/LUFA/Drivers/USB/HighLevel/USBInterrupt.h?ds=sidebyside diff --git a/LUFA/Drivers/USB/HighLevel/USBInterrupt.h b/LUFA/Drivers/USB/HighLevel/USBInterrupt.h index 65e0b5fb1..ee13f2554 100644 --- a/LUFA/Drivers/USB/HighLevel/USBInterrupt.h +++ b/LUFA/Drivers/USB/HighLevel/USBInterrupt.h @@ -28,16 +28,12 @@ this software. */ -/** \file - * - * Main USB interrupt vector handler. This file manages the main USB interrupt vector, for handling such - * events as VBUS interrupts (on supported USB AVR models), device connections and disconnections, etc. - */ - /** \ingroup Group_USB * @defgroup Group_USBInterrupt Endpoint and Pipe Interrupts * - * Functions, macros, variables, enums and types related to endpoint and pipe interrupts. + * This module manages the main USB interrupt vector, for handling such events as VBUS interrupts + * (on supported USB AVR models), device connections and disconnections, etc. as well as providing + * easy to use macros for the management of the unified Endpoint/Pipe interrupt vector. * * @{ */ @@ -74,7 +70,7 @@ /** Disables the given USB interrupt vector. * - * \see USB_INT_Enable() + * \see \ref USB_INT_Enable() */ #define USB_INT_Disable(int) MACROS{ USB_INT_GET_EN_REG(int) &= ~(USB_INT_GET_EN_MASK(int)); }MACROE @@ -100,7 +96,7 @@ * which is not always accurate (host may suspend the bus while still connected). If the actual connection state * needs to be determined, VBUS should be routed to an external pin, and the auto-detect behaviour turned off by * passing the NO_LIMITED_CONTROLLER_CONNECT token to the compiler via the -D switch at compile time. The connection - * and disconnection events may be manually fired by RAISE_EVENT(), and the USB_IsConnected global changed manually. + * and disconnection events may be manually fired by \ref RAISE_EVENT(), and the USB_IsConnected global changed manually. */ RAISES_EVENT(USB_Connect); @@ -112,7 +108,7 @@ * which is not always accurate (host may suspend the bus while still connected). If the actual connection state * needs to be determined, VBUS should be routed to an external pin, and the auto-detect behaviour turned off by * passing the NO_LIMITED_CONTROLLER_CONNECT token to the compiler via the -D switch at compile time. The connection - * and disconnection events may be manually fired by RAISE_EVENT(), and the USB_IsConnected global changed manually. + * and disconnection events may be manually fired by \ref RAISE_EVENT(), and the USB_IsConnected global changed manually. */ RAISES_EVENT(USB_Disconnect);