Documentation enhancements to improve documentation cross-references.

[pub/USBasp.git] / LUFA / Drivers / USB / LowLevel / Device.h

diff --git a/LUFA/Drivers/USB/LowLevel/Device.h b/LUFA/Drivers/USB/LowLevel/Device.h
index 206a993..b3a11d2 100644 (file)
--- a/LUFA/Drivers/USB/LowLevel/Device.h
+++ b/LUFA/Drivers/USB/LowLevel/Device.h
@@ -51,7 +51,7 @@
        /* Public Interface - May be used in end-application: */\r
                /* Macros: */\r
                        #if defined(USB_FULL_CONTROLLER) || defined(USB_MODIFIED_FULL_CONTROLLER) || defined(__DOXYGEN__)\r
        /* Public Interface - May be used in end-application: */\r
                /* Macros: */\r
                        #if defined(USB_FULL_CONTROLLER) || defined(USB_MODIFIED_FULL_CONTROLLER) || defined(__DOXYGEN__)\r

-                               /** Mask for the Options parameter of the USB_Init() function. This indicates that the\r
+                               /** Mask for the Options parameter of the \ref USB_Init() function. This indicates that the\r

                                 *  USB interface should be initialized in low speed (1.5Mb/s) mode.\r
                                 *\r
                                 *  \note Low Speed mode is not available on all USB AVR models.\r
                                 *  USB interface should be initialized in low speed (1.5Mb/s) mode.\r
                                 *\r
                                 *  \note Low Speed mode is not available on all USB AVR models.\r


@@ -78,7 +78,7 @@
                                 *  \note This macro should only be used if the device has indicated to the host that it\r
                                 *        supports the Remote Wakeup feature in the device descriptors, and should only be\r
                                 *        issued if the host is currently allowing remote wakeup events from the device (i.e.,\r
                                 *  \note This macro should only be used if the device has indicated to the host that it\r
                                 *        supports the Remote Wakeup feature in the device descriptors, and should only be\r
                                 *        issued if the host is currently allowing remote wakeup events from the device (i.e.,\r

-                                *        the USB_RemoteWakeupEnabled flag is set, see DevChapter9.h documentation).\r
+                                *        the \ref USB_RemoteWakeupEnabled flag is set).\r

                                 *\r
                                 *  \see StdDescriptors.h for more information on the RMWAKEUP feature and device descriptors.\r
                                 */\r
                                 *\r
                                 *  \see StdDescriptors.h for more information on the RMWAKEUP feature and device descriptors.\r
                                 */\r


@@ -87,7 +87,7 @@
                                /** Indicates if a Remote Wakeup request is being sent to the host. This returns true if a\r
                                 *  remote wakeup is currently being sent, false otherwise.\r
                                 *\r
                                /** Indicates if a Remote Wakeup request is being sent to the host. This returns true if a\r
                                 *  remote wakeup is currently being sent, false otherwise.\r
                                 *\r

-                                *  This can be used in conjunction with the USB_Device_IsUSBSuspended() macro to determine if\r
+                                *  This can be used in conjunction with the \ref USB_Device_IsUSBSuspended() macro to determine if\r

                                 *  a sent RMWAKEUP request was accepted or rejected by the host.\r
                                 *\r
                                 *  \note This macro should only be used if the device has indicated to the host that it\r
                                 *  a sent RMWAKEUP request was accepted or rejected by the host.\r
                                 *\r
                                 *  \note This macro should only be used if the device has indicated to the host that it\r


@@ -99,9 +99,9 @@
                                 */\r
                                static inline bool USB_Device_IsRemoteWakeupSent(void);\r
                                \r
                                 */\r
                                static inline bool USB_Device_IsRemoteWakeupSent(void);\r
                                \r

-                               /** Indicates if the device is currently suspended by the host. While suspended, the device is\r
-                                *  to enter a low power state until resumed by the host. While suspended no USB traffic to or\r
-                                *  from the device can occur (except for Remote Wakeup requests).\r
+                               /** Indicates if the device is currently suspended by the host. Whilst suspended, the device is\r
+                                *  to enter a low power state until resumed by the host. No USB traffic to or from the device\r
+                                *  can occur (except for Remote Wakeup requests) during suspension by the host.\r

                                 *\r
                                 *  \return Boolean true if the USB communications have been suspended by the host, false otherwise.\r
                                 */\r
                                 *\r
                                 *  \return Boolean true if the USB communications have been suspended by the host, false otherwise.\r
                                 */\r


@@ -115,17 +115,17 @@
                        #endif\r
 \r
                /* Enums: */\r
                        #endif\r
 \r
                /* Enums: */\r

-                       /** Enum for the ErrorCode parameter of the USB_DeviceError event.\r
+                       /** Enum for the ErrorCode parameter of the \ref USB_DeviceError event.\r

                         *\r
                         *  \see Events.h for more information on this event.\r
                         */\r
                        enum USB_Device_ErrorCodes_t\r
                        {\r
                         *\r
                         *  \see Events.h for more information on this event.\r
                         */\r
                        enum USB_Device_ErrorCodes_t\r
                        {\r

-                               DEVICE_ERROR_GetDescriptorNotHooked        = 0, /**< Indicates that the GetDescriptor() method\r
+                               DEVICE_ERROR_GetDescriptorNotHooked        = 0, /**< Indicates that the \ref USB_GetDescriptor() method\r

                                                                                 *   has not been hooked by the user application.\r
                                                                                 *\r
                                                                                 *   \see StdDescriptors.h for more information on\r
                                                                                 *   has not been hooked by the user application.\r
                                                                                 *\r
                                                                                 *   \see StdDescriptors.h for more information on\r

-                                                                                *        the GetDescriptor() method.\r
+                                                                                *        the \ref USB_GetDescriptor() method.\r

                                                                                 */\r
                        };\r
 \r
                                                                                 */\r
                        };\r
 \r