diff options
| author | Dean Camera <dean@fourwalledcubicle.com> | 2012-09-19 18:43:56 +0000 |
|---|---|---|
| committer | Dean Camera <dean@fourwalledcubicle.com> | 2012-09-19 18:43:56 +0000 |
| commit | 5f6235b195f5eb65623c806ed17fec7e217918e0 (patch) | |
| tree | fc228e63d979ac39092258669e29ace693038e58 /LUFA/Drivers/USB | |
| parent | 7d259eac4c05a60db3f18177fadbbf2ffd56dc9f (diff) | |
| download | lufa-5f6235b195f5eb65623c806ed17fec7e217918e0.tar.gz lufa-5f6235b195f5eb65623c806ed17fec7e217918e0.tar.bz2 lufa-5f6235b195f5eb65623c806ed17fec7e217918e0.zip | |
Fix missing briefs in the documentation for several modules, fix up invalid documentation references.
Diffstat (limited to 'LUFA/Drivers/USB')
| -rw-r--r-- | LUFA/Drivers/USB/Class/Device/HIDClassDevice.h | 6 | ||||
| -rw-r--r-- | LUFA/Drivers/USB/USB.h | 4 |
2 files changed, 7 insertions, 3 deletions
diff --git a/LUFA/Drivers/USB/Class/Device/HIDClassDevice.h b/LUFA/Drivers/USB/Class/Device/HIDClassDevice.h index e358dec75..41e9ab6df 100644 --- a/LUFA/Drivers/USB/Class/Device/HIDClassDevice.h +++ b/LUFA/Drivers/USB/Class/Device/HIDClassDevice.h @@ -102,8 +102,8 @@ uint8_t PrevReportINBufferSize; /**< Size in bytes of the given input report buffer. This is used to create a * second buffer of the same size within the driver so that subsequent reports * can be compared. If the user app is to determine when reports are to be sent - * exclusively (i.e. \ref PrevReportINBuffer is \c NULL) this value must still be - * set to the size of the largest report the device can issue to the host. + * exclusively (i.e. \c PrevReportINBuffer is \c NULL) this value must still be + * set to the size of the largest report the device can issue to the host. */ } Config; /**< Config data for the USB class interface within the device. All elements in this section * <b>must</b> be set or the interface will fail to enumerate and operate correctly. @@ -114,7 +114,7 @@ uint16_t PrevFrameNum; /**< Frame number of the previous HID report packet opportunity. */ uint16_t IdleCount; /**< Report idle period, in milliseconds, set by the host. */ uint16_t IdleMSRemaining; /**< Total number of milliseconds remaining before the idle period elapsed - this - * should be decremented by the user application if non-zero each millisecond. */ + * should be decremented by the user application if non-zero each millisecond. */ } 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. */ diff --git a/LUFA/Drivers/USB/USB.h b/LUFA/Drivers/USB/USB.h index 512f7029f..cabe71fdc 100644 --- a/LUFA/Drivers/USB/USB.h +++ b/LUFA/Drivers/USB/USB.h @@ -39,6 +39,8 @@ /** \defgroup Group_USB USB Core - LUFA/Drivers/USB/USB.h * + * \brief Core driver for the microcontroller hardware USB module + * * \section Sec_Dependencies Module Source Dependencies * The following files must be built with any user project that uses this module: * - LUFA/Drivers/USB/Core/ConfigDescriptors.c <i>(Makefile source module name: LUFA_SRC_USB)</i> @@ -73,6 +75,8 @@ /** \defgroup Group_USBClassDrivers USB Class Drivers * + * \brief Drivers for the various standardized USB device classes + * * Drivers for both host and device mode of the standard USB classes, for rapid application development. * Class drivers give a framework which sits on top of the low level library API, allowing for standard * USB classes to be implemented in a project with minimal user code. These drivers can be used in |