diff options
| author | Dean Camera <dean@fourwalledcubicle.com> | 2012-02-24 20:25:36 +0000 |
|---|---|---|
| committer | Dean Camera <dean@fourwalledcubicle.com> | 2012-02-24 20:25:36 +0000 |
| commit | e406140f119281a945c281d25e9a1041b862d592 (patch) | |
| tree | d8ad16a77830f8116e5ae5bdbe99fcb263a7f9d6 /LUFA/Drivers/USB/Core/XMEGA/Device_XMEGA.h | |
| parent | 5561524a8fe7baaeaac3421c9e1d3347186fdf95 (diff) | |
| download | lufa-e406140f119281a945c281d25e9a1041b862d592.tar.gz lufa-e406140f119281a945c281d25e9a1041b862d592.tar.bz2 lufa-e406140f119281a945c281d25e9a1041b862d592.zip | |
Minor documentation fixes - change \note entries to \warning where appropriate and remove/update old documentation.
Diffstat (limited to 'LUFA/Drivers/USB/Core/XMEGA/Device_XMEGA.h')
| -rw-r--r-- | LUFA/Drivers/USB/Core/XMEGA/Device_XMEGA.h | 8 |
1 files changed, 4 insertions, 4 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) |