From c75f8bf2236bc69511d0ff0bc79bfaf1f62e3bfd Mon Sep 17 00:00:00 2001 From: Dean Camera Date: Mon, 15 Jun 2009 08:36:12 +0000 Subject: More Doxygen fixes - ensure no undocumented function parameters. --- LUFA/Drivers/USB/Class/Host/CDC.h | 31 +++++++++++++++++++++++++++++++ LUFA/Drivers/USB/Class/Host/MassStorage.h | 2 +- LUFA/Drivers/USB/Class/Host/StillImage.h | 2 +- 3 files changed, 33 insertions(+), 2 deletions(-) (limited to 'LUFA/Drivers/USB') diff --git a/LUFA/Drivers/USB/Class/Host/CDC.h b/LUFA/Drivers/USB/Class/Host/CDC.h index 292411be4..3bc814daf 100644 --- a/LUFA/Drivers/USB/Class/Host/CDC.h +++ b/LUFA/Drivers/USB/Class/Host/CDC.h @@ -50,6 +50,37 @@ #endif /* Public Interface - May be used in end-application: */ + /* Type Defines: */ + typedef struct + { + bool IsActive; /**< Indicates if this class driver is currently attached to the device */ + + uint8_t ControlInterfaceNumber; /**< Interface number of the CDC control interface within the device */ + + uint8_t DataINPipeNumber; /**< Pipe number of the CDC interface's IN data pipe */ + uint16_t DataINPipeSize; /**< Size in bytes of the CDC interface's IN data pipe */ + + uint8_t DataOUTPipeNumber; /**< Pipe number of the CDC interface's OUT data pipe */ + uint16_t DataOUTPipeSize; /**< Size in bytes of the CDC interface's OUT data pipe */ + + uint8_t NotificationEndpointNumber; /**< Pipe number of the CDC interface's IN notification endpoint, if used */ + uint16_t NotificationEndpointSize; /**< Size in bytes of the CDC interface's IN notification endpoint, if used */ + + uint8_t ControlLineState; /**< Current control line states */ + + struct + { + uint32_t BaudRateBPS; /**< Baud rate of the virtual serial port, in bits per second */ + uint8_t CharFormat; /**< Character format of the virtual serial port, a value from the + * CDCDevice_CDC_LineCodingFormats_t enum + */ + uint8_t ParityType; /**< Parity setting of the virtual serial port, a value from the + * CDCDevice_LineCodingParity_t enum + */ + uint8_t DataBits; /**< Bits of data per character of the virtual serial port */ + } LineEncoding; + } USB_ClassInfo_CDC_Host_t; + /* Function Prototypes: */ void CDC_Host_Task(void); diff --git a/LUFA/Drivers/USB/Class/Host/MassStorage.h b/LUFA/Drivers/USB/Class/Host/MassStorage.h index e87a91437..edb494cc1 100644 --- a/LUFA/Drivers/USB/Class/Host/MassStorage.h +++ b/LUFA/Drivers/USB/Class/Host/MassStorage.h @@ -28,7 +28,7 @@ this software. */ -/** \ingroup Group_USBClassMassStorage +/** \ingroup Group_USBClassMS * @defgroup Group_USBClassMassStorageHost Mass Storage Class Host Mode Driver * * \section Module Description diff --git a/LUFA/Drivers/USB/Class/Host/StillImage.h b/LUFA/Drivers/USB/Class/Host/StillImage.h index c83ad5bd5..000b553b5 100644 --- a/LUFA/Drivers/USB/Class/Host/StillImage.h +++ b/LUFA/Drivers/USB/Class/Host/StillImage.h @@ -28,7 +28,7 @@ this software. */ -/** \ingroup Group_USBClassStillImage +/** \ingroup Group_USBClassSI * @defgroup Group_USBClassStillImageHost Still Image Class Host Mode Driver * * \section Module Description -- cgit v1.2.3