diff options
| author | Dean Camera <dean@fourwalledcubicle.com> | 2013-04-04 20:29:40 +0000 |
|---|---|---|
| committer | Dean Camera <dean@fourwalledcubicle.com> | 2013-04-04 20:29:40 +0000 |
| commit | 09ae9ad0046d827e6a9267bc8874a767b0078ae9 (patch) | |
| tree | 24e553ca76145851f8aa96f52e06489c0a0de024 /LUFA/Drivers/USB | |
| parent | e40f0eb2897756a7a439c2ad1610554249539697 (diff) | |
| download | lufa-09ae9ad0046d827e6a9267bc8874a767b0078ae9.tar.gz lufa-09ae9ad0046d827e6a9267bc8874a767b0078ae9.tar.bz2 lufa-09ae9ad0046d827e6a9267bc8874a767b0078ae9.zip | |
Minor documentation improvements.
Diffstat (limited to 'LUFA/Drivers/USB')
| -rw-r--r-- | LUFA/Drivers/USB/Class/Device/CDCClassDevice.h | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/LUFA/Drivers/USB/Class/Device/CDCClassDevice.h b/LUFA/Drivers/USB/Class/Device/CDCClassDevice.h index 1f259f381..b87fef1fd 100644 --- a/LUFA/Drivers/USB/Class/Device/CDCClassDevice.h +++ b/LUFA/Drivers/USB/Class/Device/CDCClassDevice.h @@ -120,9 +120,9 @@ */ } ControlLineStates; /**< Current states of the virtual serial port's control lines between the device and host. */ - CDC_LineEncoding_t LineEncoding; /** Line encoding used in the virtual serial port, for the device's information. - * This is generally only used if the virtual serial port data is to be - * reconstructed on a physical UART. + CDC_LineEncoding_t LineEncoding; /**< Line encoding used in the virtual serial port, for the device's information. + * This is generally only used if the virtual serial port data is to be + * reconstructed on a physical UART. */ } State; /**< State data for the USB class interface within the device. All elements in this section * are reset to their defaults when the interface is enumerated. @@ -157,7 +157,7 @@ /** CDC class driver event for a line encoding change on a CDC interface. This event fires each time the host requests a * line encoding change (containing the serial parity, baud and other configuration information) and may be hooked in the * user program by declaring a handler function with the same name and parameters listed here. The new line encoding - * settings are available in the LineEncoding structure inside the CDC interface structure passed as a parameter. + * settings are available in the \c LineEncoding structure inside the CDC interface structure passed as a parameter. * * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state. */ @@ -293,7 +293,7 @@ * be used when the read data is processed byte-per-bye (via \c getc()) or when the user application will implement its own * line buffering. * - * \note The created stream can be given as \c stdout if desired to direct the standard output from all <stdio.h> functions + * \note The created stream can be given as \c stdout if desired to direct the standard output from all \c <stdio.h> functions * to the given CDC interface. * \n\n * |