Minor documentation improvements.

[pub/lufa.git] / LUFA / Drivers / USB / HighLevel / EndpointStream.h

diff --git a/LUFA/Drivers/USB/HighLevel/EndpointStream.h b/LUFA/Drivers/USB/HighLevel/EndpointStream.h
index f9ca9f6..6d8491b 100644 (file)
--- a/LUFA/Drivers/USB/HighLevel/EndpointStream.h
+++ b/LUFA/Drivers/USB/HighLevel/EndpointStream.h
@@ -80,7 +80,7 @@
 \r
        /* Public Interface - May be used in end-application: */\r
                /* Enums: */\r
 \r
        /* Public Interface - May be used in end-application: */\r
                /* Enums: */\r

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

                        enum Endpoint_Stream_RW_ErrorCodes_t\r
                        {\r
                                ENDPOINT_RWSTREAM_NoError            = 0, /**< Command completed successfully, no error. */\r
                        enum Endpoint_Stream_RW_ErrorCodes_t\r
                        {\r
                                ENDPOINT_RWSTREAM_NoError            = 0, /**< Command completed successfully, no error. */\r


@@ -103,7 +103,7 @@
                                                                           */\r
                        };\r
                        \r
                                                                           */\r
                        };\r
                        \r

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

                        enum Endpoint_ControlStream_RW_ErrorCodes_t\r
                        {\r
                                ENDPOINT_RWCSTREAM_NoError            = 0, /**< Command completed successfully, no error. */\r
                        enum Endpoint_ControlStream_RW_ErrorCodes_t\r
                        {\r
                                ENDPOINT_RWCSTREAM_NoError            = 0, /**< Command completed successfully, no error. */\r


@@ -126,13 +126,13 @@
                         *  packet is ready, allowing for early aborts of stream transfers.\r
                         *\r
                         *      The callback routine should be created according to the information in \ref Group_StreamCallbacks.\r
                         *  packet is ready, allowing for early aborts of stream transfers.\r
                         *\r
                         *      The callback routine should be created according to the information in \ref Group_StreamCallbacks.\r

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

                         *  disabled and this function has the Callback parameter omitted.\r
                         *\r
                         *  \note This routine should not be used on CONTROL type endpoints.\r
                         *\r
                         *  \param[in] Length    Number of bytes to send via the currently selected endpoint.\r
                         *  disabled and this function has the Callback parameter omitted.\r
                         *\r
                         *  \note This routine should not be used on CONTROL type endpoints.\r
                         *\r
                         *  \param[in] Length    Number of bytes to send via the currently selected endpoint.\r

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

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


@@ -147,14 +147,14 @@
                         *  aborts of stream transfers.\r
                         *\r
                         *      The callback routine should be created according to the information in \ref Group_StreamCallbacks.\r
                         *  aborts of stream transfers.\r
                         *\r
                         *      The callback routine should be created according to the information in \ref Group_StreamCallbacks.\r

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

                         *  disabled and this function has the Callback parameter omitted.\r
                         *\r
                         *  \note This routine should not be used on CONTROL type endpoints.\r
                         *\r
                         *  \param[in] Buffer    Pointer to the source data buffer to read from.\r
                         *  \param[in] Length    Number of bytes to read for the currently selected endpoint into the buffer.\r
                         *  disabled and this function has the Callback parameter omitted.\r
                         *\r
                         *  \note This routine should not be used on CONTROL type endpoints.\r
                         *\r
                         *  \param[in] Buffer    Pointer to the source data buffer to read from.\r
                         *  \param[in] Length    Number of bytes to read for the currently selected endpoint into the buffer.\r

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

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


@@ -166,7 +166,7 @@
                         *\r
                         *  \param[in] Buffer    Pointer to the source data buffer to read from.\r
                         *  \param[in] Length    Number of bytes to read for the currently selected endpoint into the buffer.\r
                         *\r
                         *  \param[in] Buffer    Pointer to the source data buffer to read from.\r
                         *  \param[in] Length    Number of bytes to read for the currently selected endpoint into the buffer.\r

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

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


@@ -180,7 +180,7 @@
                         *\r
                         *  \param[in] Buffer    Pointer to the source data buffer to read from.\r
                         *  \param[in] Length    Number of bytes to read for the currently selected endpoint into the buffer.\r
                         *\r
                         *  \param[in] Buffer    Pointer to the source data buffer to read from.\r
                         *  \param[in] Length    Number of bytes to read for the currently selected endpoint into the buffer.\r

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

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


@@ -196,14 +196,14 @@
                         *  aborts of stream transfers.\r
                         *\r
                         *      The callback routine should be created according to the information in \ref Group_StreamCallbacks.\r
                         *  aborts of stream transfers.\r
                         *\r
                         *      The callback routine should be created according to the information in \ref Group_StreamCallbacks.\r

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

                         *  disabled and this function has the Callback parameter omitted.\r
                         *\r
                         *  \note This routine should not be used on CONTROL type endpoints.\r
                         *\r
                         *  \param[in] Buffer    Pointer to the source data buffer to read from.\r
                         *  \param[in] Length    Number of bytes to read for the currently selected endpoint into the buffer.\r
                         *  disabled and this function has the Callback parameter omitted.\r
                         *\r
                         *  \note This routine should not be used on CONTROL type endpoints.\r
                         *\r
                         *  \param[in] Buffer    Pointer to the source data buffer to read from.\r
                         *  \param[in] Length    Number of bytes to read for the currently selected endpoint into the buffer.\r

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

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


@@ -215,7 +215,7 @@
                         *\r
                         *  \param[in] Buffer    Pointer to the source data buffer to read from.\r
                         *  \param[in] Length    Number of bytes to read for the currently selected endpoint into the buffer.\r
                         *\r
                         *  \param[in] Buffer    Pointer to the source data buffer to read from.\r
                         *  \param[in] Length    Number of bytes to read for the currently selected endpoint into the buffer.\r

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

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


@@ -229,7 +229,7 @@
                         *\r
                         *  \param[in] Buffer    Pointer to the source data buffer to read from.\r
                         *  \param[in] Length    Number of bytes to read for the currently selected endpoint into the buffer.\r
                         *\r
                         *  \param[in] Buffer    Pointer to the source data buffer to read from.\r
                         *  \param[in] Length    Number of bytes to read for the currently selected endpoint into the buffer.\r

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

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


@@ -245,14 +245,14 @@
                         *  is ready to accept the next packet, allowing for early aborts of stream transfers.\r
                         *\r
                         *      The callback routine should be created according to the information in \ref Group_StreamCallbacks.\r
                         *  is ready to accept the next packet, allowing for early aborts of stream transfers.\r
                         *\r
                         *      The callback routine should be created according to the information in \ref Group_StreamCallbacks.\r

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

                         *  disabled and this function has the Callback parameter omitted.\r
                         *\r
                         *  \note This routine should not be used on CONTROL type endpoints.\r
                         *\r
                         *  \param[out] Buffer    Pointer to the destination data buffer to write to.\r
                         *  \param[in]  Length    Number of bytes to send via the currently selected endpoint.\r
                         *  disabled and this function has the Callback parameter omitted.\r
                         *\r
                         *  \note This routine should not be used on CONTROL type endpoints.\r
                         *\r
                         *  \param[out] Buffer    Pointer to the destination data buffer to write to.\r
                         *  \param[in]  Length    Number of bytes to send via the currently selected endpoint.\r

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

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


@@ -264,7 +264,7 @@
                         *\r
                         *  \param[out] Buffer    Pointer to the destination data buffer to write to, located in EEPROM memory space.\r
                         *  \param[in]  Length    Number of bytes to send via the currently selected endpoint.\r
                         *\r
                         *  \param[out] Buffer    Pointer to the destination data buffer to write to, located in EEPROM memory space.\r
                         *  \param[in]  Length    Number of bytes to send via the currently selected endpoint.\r

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

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


@@ -280,14 +280,14 @@
                         *  is ready to accept the next packet, allowing for early aborts of stream transfers.\r
                         *\r
                         *      The callback routine should be created according to the information in \ref Group_StreamCallbacks.\r
                         *  is ready to accept the next packet, allowing for early aborts of stream transfers.\r
                         *\r
                         *      The callback routine should be created according to the information in \ref Group_StreamCallbacks.\r

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

                         *  disabled and this function has the Callback parameter omitted.\r
                         *\r
                         *  \note This routine should not be used on CONTROL type endpoints.\r
                         *\r
                         *  \param[out] Buffer    Pointer to the destination data buffer to write to.\r
                         *  \param[in]  Length    Number of bytes to send via the currently selected endpoint.\r
                         *  disabled and this function has the Callback parameter omitted.\r
                         *\r
                         *  \note This routine should not be used on CONTROL type endpoints.\r
                         *\r
                         *  \param[out] Buffer    Pointer to the destination data buffer to write to.\r
                         *  \param[in]  Length    Number of bytes to send via the currently selected endpoint.\r

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

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


@@ -299,7 +299,7 @@
                         *\r
                         *  \param[out] Buffer    Pointer to the destination data buffer to write to, located in EEPROM memory space.\r
                         *  \param[in]  Length    Number of bytes to send via the currently selected endpoint.\r
                         *\r
                         *  \param[out] Buffer    Pointer to the destination data buffer to write to, located in EEPROM memory space.\r
                         *  \param[in]  Length    Number of bytes to send via the currently selected endpoint.\r

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

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