From b288d2a0911cb9bee87dcfda12450d08cb953470 Mon Sep 17 00:00:00 2001 From: Dean Date: Fri, 24 Feb 2012 20:25:36 +0000 Subject: Minor documentation fixes - change \note entries to \warning where appropriate and remove/update old documentation. git-svn-id: http://lufa-lib.googlecode.com/svn/trunk@2066 d5102386-fcda-11dd-9fdb-3debd5008f28 --- LUFA/Drivers/USB/Class/Device/CDCClassDevice.h | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) (limited to 'LUFA/Drivers/USB/Class/Device/CDCClassDevice.h') diff --git a/LUFA/Drivers/USB/Class/Device/CDCClassDevice.h b/LUFA/Drivers/USB/Class/Device/CDCClassDevice.h index 998b0a73..cc0dd1b1 100644 --- a/LUFA/Drivers/USB/Class/Device/CDCClassDevice.h +++ b/LUFA/Drivers/USB/Class/Device/CDCClassDevice.h @@ -53,16 +53,17 @@ * * One major issue with CDC-ACM is that it requires two Interface descriptors, * which will upset most hosts when part of a multi-function "Composite" USB - * device, as each interface will be loaded into a separate driver instance. To - * combat this, you should use the "Interface Association Descriptor" addendum to - * the USB standard which is available on most OSes when creating Composite devices. + * device. This is because each interface will be loaded into a separate driver + * instance, causing the two interfaces be become unlinked. To prevent this, you + * should use the "Interface Association Descriptor" addendum to the USB 2.0 standard + * which is available on most OSes when creating Composite devices. * * Another major oversight is that there is no mechanism for the host to notify the * device that there is a data sink on the host side ready to accept data. This * means that the device may try to send data while the host isn't listening, causing - * lengthy blocking timeouts in the transmission routines. To combat this, it is - * recommended that the virtual serial line DTR (Data Terminal Ready) be used where - * possible to determine if a host application is ready for data. + * lengthy blocking timeouts in the transmission routines. It is thus highly recommended + * that the virtual serial line DTR (Data Terminal Ready) signal be used where possible + * to determine if a host application is ready for data. * * @{ */ @@ -299,7 +300,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 stdout if desired to direct the standard output from all functions + * \note The created stream can be given as \c stdout if desired to direct the standard output from all functions * to the given CDC interface. * \n\n * -- cgit v1.2.3