Documentation enhancements to improve documentation cross-references.

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

diff --git a/LUFA/Drivers/USB/LowLevel/Pipe.h b/LUFA/Drivers/USB/LowLevel/Pipe.h
index 25121ca..748dc59 100644 (file)
--- a/LUFA/Drivers/USB/LowLevel/Pipe.h
+++ b/LUFA/Drivers/USB/LowLevel/Pipe.h
@@ -77,43 +77,43 @@
 \r
        /* Public Interface - May be used in end-application: */\r
                /* Macros: */\r
 \r
        /* Public Interface - May be used in end-application: */\r
                /* Macros: */\r

-                       /** Mask for Pipe_GetErrorFlags(), indicating that a CRC error occurred in the pipe on the received data. */\r
+                       /** Mask for \ref Pipe_GetErrorFlags(), indicating that a CRC error occurred in the pipe on the received data. */\r

                        #define PIPE_ERRORFLAG_CRC16            (1 << 4)\r
 \r
                        #define PIPE_ERRORFLAG_CRC16            (1 << 4)\r
 \r

-                       /** Mask for Pipe_GetErrorFlags(), indicating that a hardware timeout error occurred in the pipe. */\r
+                       /** Mask for \ref Pipe_GetErrorFlags(), indicating that a hardware timeout error occurred in the pipe. */\r

                        #define PIPE_ERRORFLAG_TIMEOUT          (1 << 3)\r
 \r
                        #define PIPE_ERRORFLAG_TIMEOUT          (1 << 3)\r
 \r

-                       /** Mask for Pipe_GetErrorFlags(), indicating that a hardware PID error occurred in the pipe. */\r
+                       /** Mask for \ref Pipe_GetErrorFlags(), indicating that a hardware PID error occurred in the pipe. */\r

                        #define PIPE_ERRORFLAG_PID              (1 << 2)\r
 \r
                        #define PIPE_ERRORFLAG_PID              (1 << 2)\r
 \r

-                       /** Mask for Pipe_GetErrorFlags(), indicating that a hardware data PID error occurred in the pipe. */\r
+                       /** Mask for \ref Pipe_GetErrorFlags(), indicating that a hardware data PID error occurred in the pipe. */\r

                        #define PIPE_ERRORFLAG_DATAPID          (1 << 1)\r
 \r
                        #define PIPE_ERRORFLAG_DATAPID          (1 << 1)\r
 \r

-                       /** Mask for Pipe_GetErrorFlags(), indicating that a hardware data toggle error occurred in the pipe. */\r
+                       /** Mask for \ref Pipe_GetErrorFlags(), indicating that a hardware data toggle error occurred in the pipe. */\r

                        #define PIPE_ERRORFLAG_DATATGL          (1 << 0)\r
 \r
                        #define PIPE_ERRORFLAG_DATATGL          (1 << 0)\r
 \r

-                       /** Token mask for Pipe_ConfigurePipe(). This sets the pipe as a SETUP token (for CONTROL type pipes),\r
+                       /** Token mask for \ref Pipe_ConfigurePipe(). This sets the pipe as a SETUP token (for CONTROL type pipes),\r

                         *  which will trigger a control request on the attached device when data is written to the pipe.\r
                         */\r
                        #define PIPE_TOKEN_SETUP                (0 << PTOKEN0)\r
 \r
                         *  which will trigger a control request on the attached device when data is written to the pipe.\r
                         */\r
                        #define PIPE_TOKEN_SETUP                (0 << PTOKEN0)\r
 \r

-                       /** Token mask for Pipe_ConfigurePipe(). This sets the pipe as a IN token (for non-CONTROL type pipes),\r
+                       /** Token mask for \ref Pipe_ConfigurePipe(). This sets the pipe as a IN token (for non-CONTROL type pipes),\r

                         *  indicating that the pipe data will flow from device to host.\r
                         */\r
                        #define PIPE_TOKEN_IN                   (1 << PTOKEN0)\r
 \r
                         *  indicating that the pipe data will flow from device to host.\r
                         */\r
                        #define PIPE_TOKEN_IN                   (1 << PTOKEN0)\r
 \r

-                       /** Token mask for Pipe_ConfigurePipe(). This sets the pipe as a IN token (for non-CONTROL type pipes),\r
+                       /** Token mask for \ref Pipe_ConfigurePipe(). This sets the pipe as a IN token (for non-CONTROL type pipes),\r

                         *  indicating that the pipe data will flow from host to device.\r
                         */\r
                        #define PIPE_TOKEN_OUT                  (2 << PTOKEN0)\r
 \r
                         *  indicating that the pipe data will flow from host to device.\r
                         */\r
                        #define PIPE_TOKEN_OUT                  (2 << PTOKEN0)\r
 \r

-                       /** Mask for the bank mode selection for the Pipe_ConfigurePipe() macro. This indicates that the pipe\r
+                       /** Mask for the bank mode selection for the \ref Pipe_ConfigurePipe() macro. This indicates that the pipe\r

                         *  should have one single bank, which requires less USB FIFO memory but results in slower transfers as\r
                         *  only one USB device (the AVR or the attached device) can access the pipe's bank at the one time.\r
                         */\r
                        #define PIPE_BANK_SINGLE                (0 << EPBK0)\r
 \r
                         *  should have one single bank, which requires less USB FIFO memory but results in slower transfers as\r
                         *  only one USB device (the AVR or the attached device) can access the pipe's bank at the one time.\r
                         */\r
                        #define PIPE_BANK_SINGLE                (0 << EPBK0)\r
 \r

-                       /** Mask for the bank mode selection for the Pipe_ConfigurePipe() macro. This indicates that the pipe\r
+                       /** Mask for the bank mode selection for the \ref Pipe_ConfigurePipe() macro. This indicates that the pipe\r

                         *  should have two banks, which requires more USB FIFO memory but results in faster transfers as one\r
                         *  USB device (the AVR or the attached device) can access one bank while the other accesses the second\r
                         *  bank.\r
                         *  should have two banks, which requires more USB FIFO memory but results in faster transfers as one\r
                         *  USB device (the AVR or the attached device) can access one bank while the other accesses the second\r
                         *  bank.\r


@@ -168,7 +168,7 @@
                         *  \note This interrupt must be enabled and cleared on *each* pipe which requires it (after the pipe\r
                         *        is selected), and will fire the common pipe interrupt vector.\r
                         *\r
                         *  \note This interrupt must be enabled and cleared on *each* pipe which requires it (after the pipe\r
                         *        is selected), and will fire the common pipe interrupt vector.\r
                         *\r

-                        *  \see ENDPOINT_PIPE_vect for more information on the common pipe and endpoint interrupt vector.\r
+                        *  \see \ref ENDPOINT_PIPE_vect for more information on the common pipe and endpoint interrupt vector.\r

                         */\r
                        #define PIPE_INT_IN                     UPIENX, (1 << RXINE) , UPINTX, (1 << RXINI)\r
 \r
                         */\r
                        #define PIPE_INT_IN                     UPIENX, (1 << RXINE) , UPINTX, (1 << RXINI)\r
 \r


@@ -182,7 +182,7 @@
                         *  \note This interrupt must be enabled and cleared on *each* pipe which requires it (after the pipe\r
                         *        is selected), and will fire the common pipe interrupt vector.\r
                         *\r
                         *  \note This interrupt must be enabled and cleared on *each* pipe which requires it (after the pipe\r
                         *        is selected), and will fire the common pipe interrupt vector.\r
                         *\r

-                        *  \see ENDPOINT_PIPE_vect for more information on the common pipe and endpoint interrupt vector.\r
+                        *  \see \ref ENDPOINT_PIPE_vect for more information on the common pipe and endpoint interrupt vector.\r

                         */\r
                        #define PIPE_INT_OUT                   UPIENX, (1 << TXOUTE), UPINTX, (1 << TXOUTI)\r
 \r
                         */\r
                        #define PIPE_INT_OUT                   UPIENX, (1 << TXOUTE), UPINTX, (1 << TXOUTI)\r
 \r


@@ -195,7 +195,7 @@
                         *  \note This interrupt must be enabled and cleared on *each* pipe which requires it (after the pipe\r
                         *        is selected), and will fire the common pipe interrupt vector.\r
                         *\r
                         *  \note This interrupt must be enabled and cleared on *each* pipe which requires it (after the pipe\r
                         *        is selected), and will fire the common pipe interrupt vector.\r
                         *\r

-                        *  \see ENDPOINT_PIPE_vect for more information on the common pipe and endpoint interrupt vector.\r
+                        *  \see \ref ENDPOINT_PIPE_vect for more information on the common pipe and endpoint interrupt vector.\r

                         */\r
                        #define PIPE_INT_SETUP                 UPIENX, (1 << TXSTPE) , UPINTX, (1 << TXSTPI)\r
 \r
                         */\r
                        #define PIPE_INT_SETUP                 UPIENX, (1 << TXSTPE) , UPINTX, (1 << TXSTPI)\r
 \r


@@ -208,9 +208,9 @@
                         *  \note This interrupt must be enabled and cleared on *each* pipe which requires it (after the pipe\r
                         *        is selected), and will fire the common pipe interrupt vector.\r
                         *\r
                         *  \note This interrupt must be enabled and cleared on *each* pipe which requires it (after the pipe\r
                         *        is selected), and will fire the common pipe interrupt vector.\r
                         *\r

-                        *  \see ENDPOINT_PIPE_vect for more information on the common pipe and endpoint interrupt vector.\r
+                        *  \see \ref ENDPOINT_PIPE_vect for more information on the common pipe and endpoint interrupt vector.\r

                         *\r
                         *\r

-                        *  \see Pipe_GetErrorFlags() for more information on the pipe errors.\r
+                        *  \see \ref Pipe_GetErrorFlags() for more information on the pipe errors.\r

                         */\r
                        #define PIPE_INT_ERROR                 UPIENX, (1 << PERRE), UPINTX, (1 << PERRI)\r
 \r
                         */\r
                        #define PIPE_INT_ERROR                 UPIENX, (1 << PERRE), UPINTX, (1 << PERRI)\r
 \r


@@ -223,9 +223,9 @@
                         *  \note This interrupt must be enabled and cleared on *each* pipe which requires it (after the pipe\r
                         *        is selected), and will fire the common pipe interrupt vector.\r
                         *\r
                         *  \note This interrupt must be enabled and cleared on *each* pipe which requires it (after the pipe\r
                         *        is selected), and will fire the common pipe interrupt vector.\r
                         *\r

-                        *  \see ENDPOINT_PIPE_vect for more information on the common pipe and endpoint interrupt vector.\r
+                        *  \see \ref ENDPOINT_PIPE_vect for more information on the common pipe and endpoint interrupt vector.\r

                         *\r
                         *\r

-                        *  \see Pipe_IsNAKReceived() for more information on pipe NAKs.\r
+                        *  \see \ref Pipe_IsNAKReceived() for more information on pipe NAKs.\r

                         */\r
                        #define PIPE_INT_NAK                   UPIENX, (1 << NAKEDE), UPINTX, (1 << NAKEDI)\r
 \r
                         */\r
                        #define PIPE_INT_NAK                   UPIENX, (1 << NAKEDE), UPINTX, (1 << NAKEDI)\r
 \r


@@ -238,7 +238,7 @@
                         *  \note This interrupt must be enabled and cleared on *each* pipe which requires it (after the pipe\r
                         *        is selected), and will fire the common pipe interrupt vector.\r
                         *\r
                         *  \note This interrupt must be enabled and cleared on *each* pipe which requires it (after the pipe\r
                         *        is selected), and will fire the common pipe interrupt vector.\r
                         *\r

-                        *  \see ENDPOINT_PIPE_vect for more information on the common pipe and endpoint interrupt vector.\r
+                        *  \see \ref ENDPOINT_PIPE_vect for more information on the common pipe and endpoint interrupt vector.\r

                         */\r
                        #define PIPE_INT_STALL                 UPIENX, (1 << RXSTALLE), UPINTX, (1 << RXSTALLI)\r
 \r
                         */\r
                        #define PIPE_INT_STALL                 UPIENX, (1 << RXSTALLE), UPINTX, (1 << RXSTALLI)\r
 \r


@@ -278,8 +278,7 @@
                                /** Enables the currently selected pipe so that data can be sent and received through it to and from\r
                                 *  an attached device.\r
                                 *\r
                                /** Enables the currently selected pipe so that data can be sent and received through it to and from\r
                                 *  an attached device.\r
                                 *\r

-                                *  \note Pipes must first be configured properly rather than just being enabled via the\r
-                                *        Pipe_ConfigurePipe() macro, which calls Pipe_EnablePipe() automatically.\r
+                                *  \note Pipes must first be configured properly via \ref Pipe_ConfigurePipe().\r

                                 */\r
                                static inline void Pipe_EnablePipe(void);\r
 \r
                                 */\r
                                static inline void Pipe_EnablePipe(void);\r
 \r


@@ -365,7 +364,7 @@
                                /** Determines if the master pipe error flag is set for the currently selected pipe, indicating that\r
                                 *  some sort of hardware error has occurred on the pipe.\r
                                 *\r
                                /** Determines if the master pipe error flag is set for the currently selected pipe, indicating that\r
                                 *  some sort of hardware error has occurred on the pipe.\r
                                 *\r

-                                *  \see Pipe_GetErrorFlags() macro for information on retrieving the exact error flag.\r
+                                *  \see \ref Pipe_GetErrorFlags() macro for information on retrieving the exact error flag.\r

                                 *\r
                                 *  \return Boolean true if an error has occurred on the selected pipe, false otherwise\r
                                 */\r
                                 *\r
                                 *  \return Boolean true if an error has occurred on the selected pipe, false otherwise\r
                                 */\r


@@ -445,7 +444,7 @@
                                /** Determines if the device sent a NAK (Negative Acknowledge) in response to the last sent packet on\r
                                 *  the currently selected pipe. This occurs when the host sends a packet to the device, but the device\r
                                 *  is not currently ready to handle the packet (i.e. its endpoint banks are full). Once a NAK has been\r
                                /** Determines if the device sent a NAK (Negative Acknowledge) in response to the last sent packet on\r
                                 *  the currently selected pipe. This occurs when the host sends a packet to the device, but the device\r
                                 *  is not currently ready to handle the packet (i.e. its endpoint banks are full). Once a NAK has been\r

-                                *  received, it must be cleared using Pipe_ClearNAKReceived() before the previous (or any other) packet\r
+                                *  received, it must be cleared using \ref Pipe_ClearNAKReceived() before the previous (or any other) packet\r

                                 *  can be re-sent.\r
                                 *\r
                                 *  \ingroup Group_PipePacketManagement\r
                                 *  can be re-sent.\r
                                 *\r
                                 *  \ingroup Group_PipePacketManagement\r


@@ -458,7 +457,7 @@
                                 *\r
                                 *  \ingroup Group_PipePacketManagement\r
                                 *\r
                                 *\r
                                 *  \ingroup Group_PipePacketManagement\r
                                 *\r

-                                *  \see Pipe_IsNAKReceived() for more details.\r
+                                *  \see \ref Pipe_IsNAKReceived() for more details.\r

                                 */\r
                                static inline void Pipe_ClearNAKReceived(void);\r
                                 \r
                                 */\r
                                static inline void Pipe_ClearNAKReceived(void);\r
                                 \r


@@ -559,7 +558,7 @@
                                PIPE_READYWAIT_DeviceDisconnected      = 2,     /**< Device was disconnected from the host while waiting. */\r
                                PIPE_READYWAIT_Timeout                 = 3, /**< The device failed to accept or send the next packet\r
                                                                             *   within the software timeout period set by the\r
                                PIPE_READYWAIT_DeviceDisconnected      = 2,     /**< Device was disconnected from the host while waiting. */\r
                                PIPE_READYWAIT_Timeout                 = 3, /**< The device failed to accept or send the next packet\r
                                                                             *   within the software timeout period set by the\r

-                                                                            *   USB_STREAM_TIMEOUT_MS macro.\r
+                                                                            *   \ref USB_STREAM_TIMEOUT_MS macro.\r

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


@@ -576,7 +575,7 @@
                                                                         */             \r
                                PIPE_RWSTREAM_ERROR_Timeout            = 3, /**< The device failed to accept or send the next packet\r
                                                                             *   within the software timeout period set by the\r
                                                                         */             \r
                                PIPE_RWSTREAM_ERROR_Timeout            = 3, /**< The device failed to accept or send the next packet\r
                                                                             *   within the software timeout period set by the\r

-                                                                            *   USB_STREAM_TIMEOUT_MS macro.\r
+                                                                            *   \ref USB_STREAM_TIMEOUT_MS macro.\r

                                                                             */\r
                                PIPE_RWSTREAM_ERROR_CallbackAborted    = 4, /**< Indicates that the stream's callback function aborted\r
                                                                         *   the transfer early.\r
                                                                             */\r
                                PIPE_RWSTREAM_ERROR_CallbackAborted    = 4, /**< Indicates that the stream's callback function aborted\r
                                                                         *   the transfer early.\r


@@ -811,9 +810,9 @@
                         *  numbers can handle different maximum packet sizes - refer to the chosen USB AVR's datasheet to\r
                         *  determine the maximum bank size for each pipe.\r
                         *\r
                         *  numbers can handle different maximum packet sizes - refer to the chosen USB AVR's datasheet to\r
                         *  determine the maximum bank size for each pipe.\r
                         *\r

-                        *  The banking mode may be either PIPE_BANK_SINGLE or PIPE_BANK_DOUBLE.\r
+                        *  The banking mode may be either \ref PIPE_BANK_SINGLE or \ref PIPE_BANK_DOUBLE.\r

                         *\r
                         *\r

-                        *  A newly configured pipe is frozen by default, and must be unfrozen before use via the Pipe_Unfreeze() macro.\r
+                        *  A newly configured pipe is frozen by default, and must be unfrozen before use via the \ref Pipe_Unfreeze() macro.\r

                         *\r
                         *  \note This routine will select the specified pipe, and the pipe will remain selected once the\r
                         *        routine completes regardless of if the pipe configuration succeeds.\r
                         *\r
                         *  \note This routine will select the specified pipe, and the pipe will remain selected once the\r
                         *        routine completes regardless of if the pipe configuration succeeds.\r


@@ -835,10 +834,10 @@
                        /** Writes the given number of bytes to the pipe from the given buffer in little endian,\r
                         *  sending full packets to the device as needed. The last packet filled is not automatically sent;\r
                         *  the user is responsible for manually sending the last written packet to the host via the\r
                        /** Writes the given number of bytes to the pipe from the given buffer in little endian,\r
                         *  sending full packets to the device as needed. The last packet filled is not automatically sent;\r
                         *  the user is responsible for manually sending the last written packet to the host via the\r

-                        *  Pipe_ClearOUT() macro. Between each USB packet, the given stream callback function is\r
+                        *  \ref Pipe_ClearOUT() macro. Between each USB packet, the given stream callback function is\r

                         *  executed repeatedly until the next packet is ready, allowing for early aborts of stream transfers.\r
                         *\r
                         *  executed repeatedly until the next packet is ready, allowing for early aborts of stream transfers.\r
                         *\r

-                        *      The callback routine should be created using the STREAM_CALLBACK() macro. If the token\r
+                        *      The callback routine should be created using the \ref STREAM_CALLBACK() macro. If the token\r

                         *  NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are disabled\r
                         *  and this function has the Callback parameter omitted.\r
                         *\r
                         *  NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are disabled\r
                         *  and this function has the Callback parameter omitted.\r
                         *\r


@@ -848,7 +847,7 @@
                         *  \param Length    Number of bytes to read for the currently selected pipe into the buffer.\r
                         *  \param Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback\r
                         *\r
                         *  \param Length    Number of bytes to read for the currently selected pipe into the buffer.\r
                         *  \param Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback\r
                         *\r

-                        *  \return A value from the Pipe_Stream_RW_ErrorCodes_t enum.\r
+                        *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.\r

                         */\r
                        uint8_t Pipe_Write_Stream_LE(const void* Buffer, uint16_t Length\r
                        #if !defined(NO_STREAM_CALLBACKS) || defined(__DOXYGEN__)\r
                         */\r
                        uint8_t Pipe_Write_Stream_LE(const void* Buffer, uint16_t Length\r
                        #if !defined(NO_STREAM_CALLBACKS) || defined(__DOXYGEN__)\r


@@ -859,10 +858,10 @@
                        /** Writes the given number of bytes to the pipe from the given buffer in big endian,\r
                         *  sending full packets to the device as needed. The last packet filled is not automatically sent;\r
                         *  the user is responsible for manually sending the last written packet to the host via the\r
                        /** Writes the given number of bytes to the pipe from the given buffer in big endian,\r
                         *  sending full packets to the device as needed. The last packet filled is not automatically sent;\r
                         *  the user is responsible for manually sending the last written packet to the host via the\r

-                        *  Pipe_ClearOUT() macro. Between each USB packet, the given stream callback function is\r
+                        *  \ref Pipe_ClearOUT() macro. Between each USB packet, the given stream callback function is\r

                         *  executed repeatedly until the next packet is ready, allowing for early aborts of stream transfers.\r
                         *\r
                         *  executed repeatedly until the next packet is ready, allowing for early aborts of stream transfers.\r
                         *\r

-                        *      The callback routine should be created using the STREAM_CALLBACK() macro. If the token\r
+                        *      The callback routine should be created using the \ref STREAM_CALLBACK() macro. If the token\r

                         *  NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are disabled\r
                         *  and this function has the Callback parameter omitted.\r
                         *\r
                         *  NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are disabled\r
                         *  and this function has the Callback parameter omitted.\r
                         *\r


@@ -872,7 +871,7 @@
                         *  \param Length    Number of bytes to read for the currently selected pipe into the buffer.\r
                         *  \param Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback\r
                         *\r
                         *  \param Length    Number of bytes to read for the currently selected pipe into the buffer.\r
                         *  \param Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback\r
                         *\r

-                        *  \return A value from the Pipe_Stream_RW_ErrorCodes_t enum.\r
+                        *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.\r

                         */\r
                        uint8_t Pipe_Write_Stream_BE(const void* Buffer, uint16_t Length\r
                        #if !defined(NO_STREAM_CALLBACKS) || defined(__DOXYGEN__)\r
                         */\r
                        uint8_t Pipe_Write_Stream_BE(const void* Buffer, uint16_t Length\r
                        #if !defined(NO_STREAM_CALLBACKS) || defined(__DOXYGEN__)\r


@@ -882,11 +881,11 @@
 \r
                        /** Reads and discards the given number of bytes from the pipe, discarding fully read packets from the host\r
                         *  as needed. The last packet is not automatically discarded once the remaining bytes has been read; the\r
 \r
                        /** Reads and discards the given number of bytes from the pipe, discarding fully read packets from the host\r
                         *  as needed. The last packet is not automatically discarded once the remaining bytes has been read; the\r

-                        *  user is responsible for manually discarding the last packet from the device via the Pipe_ClearIN() macro.\r
+                        *  user is responsible for manually discarding the last packet from the device via the \ref Pipe_ClearIN() macro.\r

                         *  Between each USB packet, the given stream callback function is executed repeatedly until the next packet is ready,\r
                         *  allowing for early aborts of stream transfers.\r
                         *\r
                         *  Between each USB packet, the given stream callback function is executed repeatedly until the next packet is ready,\r
                         *  allowing for early aborts of stream transfers.\r
                         *\r

-                        *      The callback routine should be created using the STREAM_CALLBACK() macro. If the token\r
+                        *      The callback routine should be created using the \ref STREAM_CALLBACK() macro. If the token\r

                         *  NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are disabled\r
                         *  and this function has the Callback parameter omitted.\r
                         *\r
                         *  NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are disabled\r
                         *  and this function has the Callback parameter omitted.\r
                         *\r


@@ -895,7 +894,7 @@
                         *  \param Length  Number of bytes to send via the currently selected pipe.\r
                         *  \param Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback\r
                         *\r
                         *  \param Length  Number of bytes to send via the currently selected pipe.\r
                         *  \param Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback\r
                         *\r

-                        *  \return A value from the Pipe_Stream_RW_ErrorCodes_t enum.\r
+                        *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.\r

                         */\r
                        uint8_t Pipe_Discard_Stream(uint16_t Length\r
                        #if !defined(NO_STREAM_CALLBACKS) || defined(__DOXYGEN__)\r
                         */\r
                        uint8_t Pipe_Discard_Stream(uint16_t Length\r
                        #if !defined(NO_STREAM_CALLBACKS) || defined(__DOXYGEN__)\r


@@ -906,10 +905,10 @@
                        /** Reads the given number of bytes from the pipe into the given buffer in little endian,\r
                         *  sending full packets to the device as needed. The last packet filled is not automatically sent;\r
                         *  the user is responsible for manually sending the last written packet to the host via the\r
                        /** Reads the given number of bytes from the pipe into the given buffer in little endian,\r
                         *  sending full packets to the device as needed. The last packet filled is not automatically sent;\r
                         *  the user is responsible for manually sending the last written packet to the host via the\r

-                        *  Pipe_ClearIN() macro. Between each USB packet, the given stream callback function is\r
+                        *  \ref Pipe_ClearIN() macro. Between each USB packet, the given stream callback function is\r

                         *  executed repeatedly until the next packet is ready, allowing for early aborts of stream transfers.\r
                         *\r
                         *  executed repeatedly until the next packet is ready, allowing for early aborts of stream transfers.\r
                         *\r

-                        *      The callback routine should be created using the STREAM_CALLBACK() macro. If the token\r
+                        *      The callback routine should be created using the \ref STREAM_CALLBACK() macro. If the token\r

                         *  NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are disabled\r
                         *  and this function has the Callback parameter omitted.\r
                         *\r
                         *  NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are disabled\r
                         *  and this function has the Callback parameter omitted.\r
                         *\r


@@ -919,7 +918,7 @@
                         *  \param Length    Number of bytes to read for the currently selected pipe to read from.\r
                         *  \param Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback\r
                         *\r
                         *  \param Length    Number of bytes to read for the currently selected pipe to read from.\r
                         *  \param Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback\r
                         *\r

-                        *  \return A value from the Pipe_Stream_RW_ErrorCodes_t enum.\r
+                        *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.\r

                         */\r
                        uint8_t Pipe_Read_Stream_LE(void* Buffer, uint16_t Length\r
                        #if !defined(NO_STREAM_CALLBACKS) || defined(__DOXYGEN__)\r
                         */\r
                        uint8_t Pipe_Read_Stream_LE(void* Buffer, uint16_t Length\r
                        #if !defined(NO_STREAM_CALLBACKS) || defined(__DOXYGEN__)\r


@@ -930,10 +929,10 @@
                        /** Reads the given number of bytes from the pipe into the given buffer in big endian,\r
                         *  sending full packets to the device as needed. The last packet filled is not automatically sent;\r
                         *  the user is responsible for manually sending the last written packet to the host via the\r
                        /** Reads the given number of bytes from the pipe into the given buffer in big endian,\r
                         *  sending full packets to the device as needed. The last packet filled is not automatically sent;\r
                         *  the user is responsible for manually sending the last written packet to the host via the\r

-                        *  Pipe_ClearIN() macro. Between each USB packet, the given stream callback function is\r
+                        *  \ref Pipe_ClearIN() macro. Between each USB packet, the given stream callback function is\r

                         *  executed repeatedly until the next packet is ready, allowing for early aborts of stream transfers.\r
                         *\r
                         *  executed repeatedly until the next packet is ready, allowing for early aborts of stream transfers.\r
                         *\r

-                        *      The callback routine should be created using the STREAM_CALLBACK() macro. If the token\r
+                        *      The callback routine should be created using the \ref STREAM_CALLBACK() macro. If the token\r

                         *  NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are disabled\r
                         *  and this function has the Callback parameter omitted.\r
                         *\r
                         *  NO_STREAM_CALLBACKS is passed via the -D option to the compiler, stream callbacks are disabled\r
                         *  and this function has the Callback parameter omitted.\r
                         *\r


@@ -943,7 +942,7 @@
                         *  \param Length    Number of bytes to read for the currently selected pipe to read from.\r
                         *  \param Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback\r
                         *\r
                         *  \param Length    Number of bytes to read for the currently selected pipe to read from.\r
                         *  \param Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback\r
                         *\r

-                        *  \return A value from the Pipe_Stream_RW_ErrorCodes_t enum.\r
+                        *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.\r

                         */\r
                        uint8_t Pipe_Read_Stream_BE(void* Buffer, uint16_t Length\r
                        #if !defined(NO_STREAM_CALLBACKS) || defined(__DOXYGEN__)\r
                         */\r
                        uint8_t Pipe_Read_Stream_BE(void* Buffer, uint16_t Length\r
                        #if !defined(NO_STREAM_CALLBACKS) || defined(__DOXYGEN__)\r