X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/35bdada24b49c4dd1900a78a1595077b99814cf9..1d8bb8f9bc90a492073b93ef3b422ac947c873e7:/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 5138032da..55f530ba9 100644 --- a/LUFA/Drivers/USB/Class/Common/CDC.h +++ b/LUFA/Drivers/USB/Class/Common/CDC.h @@ -1,21 +1,21 @@ /* LUFA Library - Copyright (C) Dean Camera, 2009. + Copyright (C) Dean Camera, 2010. dean [at] fourwalledcubicle [dot] com www.fourwalledcubicle.com */ /* - Copyright 2009 Dean Camera (dean [at] fourwalledcubicle [dot] com) - - Permission to use, copy, modify, and distribute this software - and its documentation for any purpose and without fee is hereby - granted, provided that the above copyright notice appear in all - copies and that both that the copyright notice and this - permission notice and warranty disclaimer appear in supporting - documentation, and that the name of the author not be used in - advertising or publicity pertaining to distribution of the + Copyright 2010 Dean Camera (dean [at] fourwalledcubicle [dot] com) + + Permission to use, copy, modify, distribute, and sell this + software and its documentation for any purpose is hereby granted + without fee, provided that the above copyright notice appear in + all copies and that both that the copyright notice and this + permission notice and warranty disclaimer appear in supporting + documentation, and that the name of the author not be used in + advertising or publicity pertaining to distribution of the software without specific, written prior permission. The author disclaim all warranties with regard to this @@ -29,6 +29,12 @@ */ /** \ingroup Group_USBClassCDC + * @defgroup Group_USBClassCDCCommon Common Class Definitions + * + * \section Module Description + * Constants, Types and Enum definitions that are common to both Device and Host modes for the USB + * CDC Class. + * * @{ */ @@ -45,6 +51,11 @@ extern "C" { #endif + /* Preprocessor Checks: */ + #if !defined(__INCLUDE_FROM_CDC_DRIVER) + #error Do not include this file directly. Include LUFA/Drivers/Class/CDC.h instead. + #endif + /* Macros: */ /** CDC Class specific request to get the current virtual serial port configuration settings. */ #define REQ_GetLineEncoding 0x21 @@ -111,7 +122,7 @@ * a single typedef struct. A macro is used instead so that functional descriptors can be created * easily by specifying the size of the payload. This allows sizeof() to work correctly. * - * \param DataSize Size in bytes of the CDC functional descriptor's data payload + * \param[in] DataSize Size in bytes of the CDC functional descriptor's data payload */ #define CDC_FUNCTIONAL_DESCRIPTOR(DataSize) \ struct \