Minor documentation improvements.

5 files changed, 45 insertions, 45 deletions

diff --git a/LUFA/Drivers/USB/HighLevel/ConfigDescriptor.h b/LUFA/Drivers/USB/HighLevel/ConfigDescriptor.h
index 7852ef63d..3ef95a406 100644
--- a/LUFA/Drivers/USB/HighLevel/ConfigDescriptor.h
+++ b/LUFA/Drivers/USB/HighLevel/ConfigDescriptor.h
@@ -71,7 +71,7 @@
 	/* Public Interface - May be used in end-application: */
 		/* Macros: */
 			/** Mask for determining the type of an endpoint from an endpoint descriptor. This should then be compared
-			 *  with the EP_TYPE_* masks to determine the exact type of the endpoint.
+			 *  with the \c EP_TYPE_* masks to determine the exact type of the endpoint.
 			 */
 			#define EP_TYPE_MASK                       0x03
 
@@ -152,7 +152,7 @@
 			{
 				DESCRIPTOR_SEARCH_COMP_Found           = 0, /**< Configuration descriptor now points to descriptor which matches
 				                                             *   search criteria of the given comparator function. */
-				DESCRIPTOR_SEARCH_COMP_Fail            = 1, /**< Comparator function returned Descriptor_Search_Fail. */
+				DESCRIPTOR_SEARCH_COMP_Fail            = 1, /**< Comparator function returned \ref DESCRIPTOR_SEARCH_Fail. */
 				DESCRIPTOR_SEARCH_COMP_EndOfDescriptor = 2, /**< End of configuration descriptor reached before match found. */
 			};
 
@@ -162,7 +162,7 @@
 			 *
 			 *  \param[in]     ConfigNumber   Device configuration descriptor number to fetch from the device (usually set to 1 for
 			 *                                single configuration devices).
-			 *  \param[in,out] ConfigSizePtr  Pointer to a uint16_t for storing the retrieved configuration descriptor size.
+			 *  \param[in,out] ConfigSizePtr  Pointer to a location for storing the retrieved configuration descriptor size.
 			 *  \param[out]    BufferPtr      Pointer to the buffer for storing the configuration descriptor data.
 			 *  \param[out]    BufferSize     Size of the allocated buffer where the configuration descriptor is to be stored.
 			 *
diff --git a/LUFA/Drivers/USB/HighLevel/DeviceStandardReq.h b/LUFA/Drivers/USB/HighLevel/DeviceStandardReq.h
index b746a85e7..4e67f8ae5 100644
--- a/LUFA/Drivers/USB/HighLevel/DeviceStandardReq.h
+++ b/LUFA/Drivers/USB/HighLevel/DeviceStandardReq.h
@@ -73,8 +73,8 @@
 
 		/* Enums: */
 			#if !defined(USE_FLASH_DESCRIPTORS) && !defined(USE_EEPROM_DESCRIPTORS) && !defined(USE_RAM_DESCRIPTORS)
-				/** Enum for the possible descriptor memory spaces, for the MemoryAddressSpace of the
-				 *  \ref CALLBACK_USB_GetDescriptor() function. This can be used when none of the USE_*_DESCRIPTORS
+				/** Enum for the possible descriptor memory spaces, for the \c MemoryAddressSpace parameter of the
+				 *  \ref CALLBACK_USB_GetDescriptor() function. This can be used when none of the \c USE_*_DESCRIPTORS
 				 *  compile time options are used, to indicate in which memory space the descriptor is stored.
 				 *
 				 *  \ingroup Group_Device
@@ -109,7 +109,7 @@
 				 *
 				 *  \note To reduce FLASH usage of the compiled applications where Remote Wakeup is not supported,
 				 *        this global and the underlying management code can be disabled by defining the
-				 *        NO_DEVICE_REMOTE_WAKEUP token in the project makefile and passing it to the compiler via
+				 *        \c NO_DEVICE_REMOTE_WAKEUP token in the project makefile and passing it to the compiler via
 				 *        the -D switch.
 				 *
 				 *  \ingroup Group_Device
diff --git a/LUFA/Drivers/USB/HighLevel/EndpointStream.h b/LUFA/Drivers/USB/HighLevel/EndpointStream.h
index f9ca9f6cb..6d8491b58 100644
--- a/LUFA/Drivers/USB/HighLevel/EndpointStream.h
+++ b/LUFA/Drivers/USB/HighLevel/EndpointStream.h
@@ -80,7 +80,7 @@
 

 	/* Public Interface - May be used in end-application: */

 		/* Enums: */

-			/** Enum for the possible error return codes of the Endpoint_*_Stream_* functions. */

+			/** Enum for the possible error return codes of the \c Endpoint_*_Stream_* functions. */

 			enum Endpoint_Stream_RW_ErrorCodes_t

 			{

 				ENDPOINT_RWSTREAM_NoError            = 0, /**< Command completed successfully, no error. */

@@ -103,7 +103,7 @@
 				                                           */

 			};

 			

-			/** Enum for the possible error return codes of the Endpoint_*_Control_Stream_* functions. */

+			/** Enum for the possible error return codes of the \c Endpoint_*_Control_Stream_* functions. */

 			enum Endpoint_ControlStream_RW_ErrorCodes_t

 			{

 				ENDPOINT_RWCSTREAM_NoError            = 0, /**< Command completed successfully, no error. */

@@ -126,13 +126,13 @@
 			 *  packet is ready, allowing for early aborts of stream transfers.

 			 *

 			 *	The callback routine should be created according to the information in \ref Group_StreamCallbacks.

-			 *  If the token NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are

+			 *  If the token \c NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are

 			 *  disabled and this function has the Callback parameter omitted.

 			 *

 			 *  \note This routine should not be used on CONTROL type endpoints.

 			 *

 			 *  \param[in] Length    Number of bytes to send via the currently selected endpoint.

-			 *  \param[in] Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback.

+			 *  \param[in] Callback  Name of a callback routine to call between successive USB packet transfers, \c NULL if no callback.

 			 *

 			 *  \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.

 			 */

@@ -147,14 +147,14 @@
 			 *  aborts of stream transfers.

 			 *

 			 *	The callback routine should be created according to the information in \ref Group_StreamCallbacks.

-			 *  If the token NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are

+			 *  If the token \c NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are

 			 *  disabled and this function has the Callback parameter omitted.

 			 *

 			 *  \note This routine should not be used on CONTROL type endpoints.

 			 *

 			 *  \param[in] Buffer    Pointer to the source data buffer to read from.

 			 *  \param[in] Length    Number of bytes to read for the currently selected endpoint into the buffer.

-			 *  \param[in] Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback.

+			 *  \param[in] Callback  Name of a callback routine to call between successive USB packet transfers, \c NULL if no callback.

 			 *

 			 *  \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.

 			 */

@@ -166,7 +166,7 @@
 			 *

 			 *  \param[in] Buffer    Pointer to the source data buffer to read from.

 			 *  \param[in] Length    Number of bytes to read for the currently selected endpoint into the buffer.

-			 *  \param[in] Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback.

+			 *  \param[in] Callback  Name of a callback routine to call between successive USB packet transfers, \c NULL if no callback.

 			 *

 			 *  \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.

 			 */

@@ -180,7 +180,7 @@
 			 *

 			 *  \param[in] Buffer    Pointer to the source data buffer to read from.

 			 *  \param[in] Length    Number of bytes to read for the currently selected endpoint into the buffer.

-			 *  \param[in] Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback.

+			 *  \param[in] Callback  Name of a callback routine to call between successive USB packet transfers, \c NULL if no callback.

 			 *

 			 *  \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.

 			 */

@@ -196,14 +196,14 @@
 			 *  aborts of stream transfers.

 			 *

 			 *	The callback routine should be created according to the information in \ref Group_StreamCallbacks.

-			 *  If the token NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are

+			 *  If the token \c NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are

 			 *  disabled and this function has the Callback parameter omitted.

 			 *

 			 *  \note This routine should not be used on CONTROL type endpoints.

 			 *

 			 *  \param[in] Buffer    Pointer to the source data buffer to read from.

 			 *  \param[in] Length    Number of bytes to read for the currently selected endpoint into the buffer.

-			 *  \param[in] Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback.

+			 *  \param[in] Callback  Name of a callback routine to call between successive USB packet transfers, \c NULL if no callback.

 			 *

 			 *  \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.

 			 */

@@ -215,7 +215,7 @@
 			 *

 			 *  \param[in] Buffer    Pointer to the source data buffer to read from.

 			 *  \param[in] Length    Number of bytes to read for the currently selected endpoint into the buffer.

-			 *  \param[in] Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback.

+			 *  \param[in] Callback  Name of a callback routine to call between successive USB packet transfers, \c NULL if no callback.

 			 *

 			 *  \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.

 			 */

@@ -229,7 +229,7 @@
 			 *

 			 *  \param[in] Buffer    Pointer to the source data buffer to read from.

 			 *  \param[in] Length    Number of bytes to read for the currently selected endpoint into the buffer.

-			 *  \param[in] Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback.

+			 *  \param[in] Callback  Name of a callback routine to call between successive USB packet transfers, \c NULL if no callback.

 			 *

 			 *  \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.

 			 */

@@ -245,14 +245,14 @@
 			 *  is ready to accept the next packet, allowing for early aborts of stream transfers.

 			 *

 			 *	The callback routine should be created according to the information in \ref Group_StreamCallbacks.

-			 *  If the token NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are

+			 *  If the token \c NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are

 			 *  disabled and this function has the Callback parameter omitted.

 			 *

 			 *  \note This routine should not be used on CONTROL type endpoints.

 			 *

 			 *  \param[out] Buffer    Pointer to the destination data buffer to write to.

 			 *  \param[in]  Length    Number of bytes to send via the currently selected endpoint.

-			 *  \param[in]  Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback.

+			 *  \param[in]  Callback  Name of a callback routine to call between successive USB packet transfers, \c NULL if no callback.

 			 *

 			 *  \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.

 			 */

@@ -264,7 +264,7 @@
 			 *

 			 *  \param[out] Buffer    Pointer to the destination data buffer to write to, located in EEPROM memory space.

 			 *  \param[in]  Length    Number of bytes to send via the currently selected endpoint.

-			 *  \param[in]  Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback.

+			 *  \param[in]  Callback  Name of a callback routine to call between successive USB packet transfers, \c NULL if no callback.

 			 *

 			 *  \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.

 			 */

@@ -280,14 +280,14 @@
 			 *  is ready to accept the next packet, allowing for early aborts of stream transfers.

 			 *

 			 *	The callback routine should be created according to the information in \ref Group_StreamCallbacks.

-			 *  If the token NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are

+			 *  If the token \c NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are

 			 *  disabled and this function has the Callback parameter omitted.

 			 *

 			 *  \note This routine should not be used on CONTROL type endpoints.

 			 *

 			 *  \param[out] Buffer    Pointer to the destination data buffer to write to.

 			 *  \param[in]  Length    Number of bytes to send via the currently selected endpoint.

-			 *  \param[in]  Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback.

+			 *  \param[in]  Callback  Name of a callback routine to call between successive USB packet transfers, \c NULL if no callback.

 			 *

 			 *  \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.

 			 */

@@ -299,7 +299,7 @@
 			 *

 			 *  \param[out] Buffer    Pointer to the destination data buffer to write to, located in EEPROM memory space.

 			 *  \param[in]  Length    Number of bytes to send via the currently selected endpoint.

-			 *  \param[in]  Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback.

+			 *  \param[in]  Callback  Name of a callback routine to call between successive USB packet transfers, \c NULL if no callback.

 			 *

 			 *  \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.

 			 */

diff --git a/LUFA/Drivers/USB/HighLevel/Events.h b/LUFA/Drivers/USB/HighLevel/Events.h
index f5d17bb89..3be69a2ef 100644
--- a/LUFA/Drivers/USB/HighLevel/Events.h
+++ b/LUFA/Drivers/USB/HighLevel/Events.h
@@ -95,7 +95,7 @@
 			 *  \note This event only exists on USB AVR models which support dual role modes.
 			 *        \n\n
 			 *
-			 *  \note This event does not exist if the USB_DEVICE_ONLY or USB_HOST_ONLY tokens have been supplied
+			 *  \note This event does not exist if the \c USB_DEVICE_ONLY or \c USB_HOST_ONLY tokens have been supplied
 			 *        to the compiler (see \ref Group_USBManagement documentation).
 			 */
 			void EVENT_USB_UIDChange(void);
@@ -108,7 +108,7 @@
 			 *  \note This event only exists on USB AVR models which supports host mode.
 			 *        \n\n
 			 *
-			 *  \note This event does not exist if the USB_DEVICE_ONLY token is supplied to the compiler (see
+			 *  \note This event does not exist if the \c USB_DEVICE_ONLY token is supplied to the compiler (see
 			 *        \ref Group_USBManagement documentation).
 			 */
 			void EVENT_USB_Host_HostError(const uint8_t ErrorCode);
@@ -121,7 +121,7 @@
 			 *  \note This event only exists on USB AVR models which supports host mode.
 			 *        \n\n
 			 *
-			 *  \note This event does not exist if the USB_DEVICE_ONLY token is supplied to the compiler (see
+			 *  \note This event does not exist if the \c USB_DEVICE_ONLY token is supplied to the compiler (see
 			 *        \ref Group_USBManagement documentation).
 			 *
 			 *  \see \ref USB_USBTask() for more information on the USB management task and reducing CPU usage.
@@ -135,7 +135,7 @@
 			 *  \note This event only exists on USB AVR models which supports host mode.
 			 *        \n\n
 			 *
-			 *  \note This event does not exist if the USB_DEVICE_ONLY token is supplied to the compiler (see
+			 *  \note This event does not exist if the \c USB_DEVICE_ONLY token is supplied to the compiler (see
 			 *        \ref Group_USBManagement documentation).
 			 *
 			 *  \see \ref USB_USBTask() for more information on the USB management task and reducing CPU usage.
@@ -155,7 +155,7 @@
 			 *  \note This event only exists on USB AVR models which supports host mode.
 			 *        \n\n
 			 *
-			 *  \note This event does not exist if the USB_DEVICE_ONLY token is supplied to the compiler (see
+			 *  \note This event does not exist if the \c USB_DEVICE_ONLY token is supplied to the compiler (see
 			 *        \ref Group_USBManagement documentation).
 			 */
 			void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode,
@@ -183,7 +183,7 @@
 			 *        a USB device.
 			 *        \n\n
 			 *
-			 *  \note This event does not exist if the USB_DEVICE_ONLY token is supplied to the compiler (see
+			 *  \note This event does not exist if the \c USB_DEVICE_ONLY token is supplied to the compiler (see
 			 *        \ref Group_USBManagement documentation).
 			 */
 			void EVENT_USB_Host_StartOfFrame(void);
@@ -198,14 +198,14 @@
 			 *        this means that the current connection state is derived from the bus suspension and wake up events by default,
 			 *        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
+			 *        passing the \c NO_LIMITED_CONTROLLER_CONNECT token to the compiler via the -D switch at compile time. The connection
 			 *        and disconnection events may be manually fired, and the \ref USB_DeviceState global changed manually.
 			 *        \n\n
 			 *
 			 *  \note This event may fire multiple times during device enumeration on the series 2 USB AVRs with limited USB controllers
-			 *        if NO_LIMITED_CONTROLLER_CONNECT is not defined.
+			 *        if \c NO_LIMITED_CONTROLLER_CONNECT is not defined.
 			 *
-			 *  \see USBTask.h for more information on the USB management task and reducing CPU usage.
+			 *  \see \ref Group_USBManagement for more information on the USB management task and reducing CPU usage.
 			 */
 			void EVENT_USB_Device_Connect(void);
 
@@ -216,14 +216,14 @@
 			 *        this means that the current connection state is derived from the bus suspension and wake up events by default,
 			 *        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
+			 *        passing the \c NO_LIMITED_CONTROLLER_CONNECT token to the compiler via the -D switch at compile time. The connection
 			 *        and disconnection events may be manually fired, and the \ref USB_DeviceState global changed manually.
 			 *        \n\n
 			 *
 			 *  \note This event may fire multiple times during device enumeration on the series 2 USB AVRs with limited USB controllers
-			 *        if NO_LIMITED_CONTROLLER_CONNECT is not defined.
+			 *        if \c NO_LIMITED_CONTROLLER_CONNECT is not defined.
 			 *
-			 *  \see USBTask.h for more information on the USB management task and reducing CPU usage.
+			 *  \see \ref Group_USBManagement for more information on the USB management task and reducing CPU usage.
 			 */
 			void EVENT_USB_Device_Disconnect(void);
 
@@ -242,7 +242,7 @@
 			 *  for the user to process via this event if desired. If not handled in the user application or by
 			 *  the library internally, unknown requests are automatically STALLed.
 			 *
-			 *  \note This event does not exist if the USB_HOST_ONLY token is supplied to the compiler (see
+			 *  \note This event does not exist if the \c USB_HOST_ONLY token is supplied to the compiler (see
 			 *        \ref Group_USBManagement documentation).
 			 *        \n\n
 			 *
@@ -262,7 +262,7 @@
 			 *
 			 *  This event fires after the value of \ref USB_ConfigurationNumber has been changed.
 			 *
-			 *  \note This event does not exist if the USB_HOST_ONLY token is supplied to the compiler (see
+			 *  \note This event does not exist if the \c USB_HOST_ONLY token is supplied to the compiler (see
 			 *        \ref Group_USBManagement documentation).
 			 */
 			void EVENT_USB_Device_ConfigurationChanged(void);
@@ -273,11 +273,11 @@
 			 *  enumerated with the \ref USB_OPT_AUTO_PLL option set, the library will automatically suspend the
 			 *  USB PLL before the event is fired to save power.
 			 *
-			 *  \note This event does not exist if the USB_HOST_ONLY token is supplied to the compiler (see
+			 *  \note This event does not exist if the \c USB_HOST_ONLY token is supplied to the compiler (see
 			 *        \ref Group_USBManagement documentation).
 			 *        \n\n
 			 *
-			 *  \note This event does not exist on the series 2 USB AVRs when the NO_LIMITED_CONTROLLER_CONNECT
+			 *  \note This event does not exist on the series 2 USB AVRs when the \c NO_LIMITED_CONTROLLER_CONNECT
 			 *        compile time token is not set - see \ref EVENT_USB_Device_Disconnect.
 			 *
 			 *  \see \ref EVENT_USB_Device_WakeUp() event for accompanying Wake Up event.
@@ -290,11 +290,11 @@
 			 *  mode. If the USB interface is enumerated with the \ref USB_OPT_AUTO_PLL option set, the library
 			 *  will automatically restart the USB PLL before the event is fired.
 			 *
-			 *  \note This event does not exist if the USB_HOST_ONLY token is supplied to the compiler (see
+			 *  \note This event does not exist if the \c USB_HOST_ONLY token is supplied to the compiler (see
 			 *        \ref Group_USBManagement documentation).
 			 *        \n\n
 			 *
-			 *  \note This event does not exist on the series 2 USB AVRs when the NO_LIMITED_CONTROLLER_CONNECT
+			 *  \note This event does not exist on the series 2 USB AVRs when the \c NO_LIMITED_CONTROLLER_CONNECT
 			 *        compile time token is not set - see \ref EVENT_USB_Device_Connect.
 			 *
 			 *  \see \ref EVENT_USB_Device_Suspend() event for accompanying Suspend event.
@@ -308,7 +308,7 @@
 			 *  This event is time-critical; exceeding OS-specific delays within this event handler (typically of around
 			 *  two seconds) will prevent the device from enumerating correctly.
 			 *
-			 *  \note This event does not exist if the USB_HOST_ONLY token is supplied to the compiler (see
+			 *  \note This event does not exist if the \c USB_HOST_ONLY token is supplied to the compiler (see
 			 *        \ref Group_USBManagement documentation).
 			 */
 			void EVENT_USB_Device_Reset(void);
@@ -324,7 +324,7 @@
 			 *        \ref USB_Device_EnableSOFEvents() and \ref USB_Device_DisableSOFEvents() commands after enumeration.
 			 *        \n\n
 			 *
-			 *  \note This event does not exist if the USB_HOST_ONLY token is supplied to the compiler (see
+			 *  \note This event does not exist if the \c USB_HOST_ONLY token is supplied to the compiler (see
 			 *        \ref Group_USBManagement documentation).
 			 */
 			void EVENT_USB_Device_StartOfFrame(void);
diff --git a/LUFA/Drivers/USB/HighLevel/HostStandardReq.h b/LUFA/Drivers/USB/HighLevel/HostStandardReq.h
index a73ccd26f..9d2c2052f 100644
--- a/LUFA/Drivers/USB/HighLevel/HostStandardReq.h
+++ b/LUFA/Drivers/USB/HighLevel/HostStandardReq.h
@@ -87,7 +87,7 @@
 			 *  \ingroup Group_PipeControlReq
 			 *
 			 *  \param[in] BufferPtr  Pointer to the start of the data buffer if the request has a data stage, or
-			 *                        NULL if the request transfers no data to or from the device.
+			 *                        \c NULL if the request transfers no data to or from the device.
 			 *
 			 *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum to indicate the result.
 			 */