diff options
| author | Dean Camera <dean@fourwalledcubicle.com> | 2009-06-15 08:36:12 +0000 |
|---|---|---|
| committer | Dean Camera <dean@fourwalledcubicle.com> | 2009-06-15 08:36:12 +0000 |
| commit | c75f8bf2236bc69511d0ff0bc79bfaf1f62e3bfd (patch) | |
| tree | 9626505319264bcedb554e9fb70a568673c6c22a /LUFA | |
| parent | 234d0a39eb3e261a1ddfcea31d7104e3400b2491 (diff) | |
| download | lufa-c75f8bf2236bc69511d0ff0bc79bfaf1f62e3bfd.tar.gz lufa-c75f8bf2236bc69511d0ff0bc79bfaf1f62e3bfd.tar.bz2 lufa-c75f8bf2236bc69511d0ff0bc79bfaf1f62e3bfd.zip | |
More Doxygen fixes - ensure no undocumented function parameters.
Diffstat (limited to 'LUFA')
| -rw-r--r-- | LUFA/Doxygen.conf | 2 | ||||
| -rw-r--r-- | LUFA/Drivers/USB/Class/Host/CDC.h | 31 | ||||
| -rw-r--r-- | LUFA/Drivers/USB/Class/Host/MassStorage.h | 2 | ||||
| -rw-r--r-- | LUFA/Drivers/USB/Class/Host/StillImage.h | 2 |
4 files changed, 34 insertions, 3 deletions
diff --git a/LUFA/Doxygen.conf b/LUFA/Doxygen.conf index 3b94c4bac..440031393 100644 --- a/LUFA/Doxygen.conf +++ b/LUFA/Doxygen.conf @@ -592,7 +592,7 @@ RECURSIVE = YES # excluded from the INPUT source files. This way you can easily exclude a
# subdirectory from a directory tree whose root is specified with the INPUT tag.
-EXCLUDE =
+EXCLUDE = Documentation/
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
# directories that are symbolic links (a Unix filesystem feature) are excluded
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
|