Rename PDIProtocol.c/.h to XPROGProtocol.c/.h as it will now handle both TPI and...

[pub/USBasp.git] / LUFA / Drivers / USB / Class / Common / CDC.h

diff --git a/LUFA/Drivers/USB/Class/Common/CDC.h b/LUFA/Drivers/USB/Class/Common/CDC.h
index ccc3268..d7f6816 100644 (file)
--- a/LUFA/Drivers/USB/Class/Common/CDC.h
+++ b/LUFA/Drivers/USB/Class/Common/CDC.h
@@ -29,6 +29,12 @@
 */\r
 \r
 /** \ingroup Group_USBClassCDC\r
 */\r
 \r
 /** \ingroup Group_USBClassCDC\r

+ *  @defgroup Group_USBClassCDCCommon  Common Class Definitions\r
+ *\r
+ *  \section Module Description\r
+ *  Constants, Types and Enum definitions that are common to both Device and Host modes for the USB\r
+ *  CDC Class.\r
+ *\r

  *  @{\r
  */\r
  \r
  *  @{\r
  */\r
  \r


@@ -111,7 +117,7 @@
                 *  a single typedef struct. A macro is used instead so that functional descriptors can be created\r
                 *  easily by specifying the size of the payload. This allows sizeof() to work correctly.\r
                 *\r
                 *  a single typedef struct. A macro is used instead so that functional descriptors can be created\r
                 *  easily by specifying the size of the payload. This allows sizeof() to work correctly.\r
                 *\r

-                *  \param DataSize  Size in bytes of the CDC functional descriptor's data payload\r
+                *  \param[in] DataSize  Size in bytes of the CDC functional descriptor's data payload\r

                 */\r
                #define CDC_FUNCTIONAL_DESCRIPTOR(DataSize)        \\r
                     struct                                        \\r
                 */\r
                #define CDC_FUNCTIONAL_DESCRIPTOR(DataSize)        \\r
                     struct                                        \\r


@@ -123,7 +129,7 @@
 \r
        /* Enums: */\r
                /** Enum for the possible line encoding formats of a virtual serial port. */\r
 \r
        /* Enums: */\r
                /** Enum for the possible line encoding formats of a virtual serial port. */\r

-               enum CDCDevice_CDC_LineCodingFormats_t\r
+               enum CDC_LineCodingFormats_t\r

                {\r
                        CDC_LINEENCODING_OneStopBit          = 0, /**< Each frame contains one stop bit */\r
                        CDC_LINEENCODING_OneAndAHalfStopBits = 1, /**< Each frame contains one and a half stop bits */\r
                {\r
                        CDC_LINEENCODING_OneStopBit          = 0, /**< Each frame contains one stop bit */\r
                        CDC_LINEENCODING_OneAndAHalfStopBits = 1, /**< Each frame contains one and a half stop bits */\r


@@ -131,7 +137,7 @@
                };\r
                \r
                /** Enum for the possible line encoding parity settings of a virtual serial port. */\r
                };\r
                \r
                /** Enum for the possible line encoding parity settings of a virtual serial port. */\r

-               enum CDCDevice_LineCodingParity_t\r
+               enum CDC_LineCodingParity_t\r

                {\r
                        CDC_PARITY_None    = 0, /**< No parity bit mode on each frame */\r
                        CDC_PARITY_Odd     = 1, /**< Odd parity bit mode on each frame */\r
                {\r
                        CDC_PARITY_None    = 0, /**< No parity bit mode on each frame */\r
                        CDC_PARITY_Odd     = 1, /**< Odd parity bit mode on each frame */\r