From 5f6235b195f5eb65623c806ed17fec7e217918e0 Mon Sep 17 00:00:00 2001 From: Dean Camera Date: Wed, 19 Sep 2012 18:43:56 +0000 Subject: [PATCH] Fix missing briefs in the documentation for several modules, fix up invalid documentation references. --- LUFA/DoxygenPages/Groups.txt | 12 ++++++------ LUFA/Drivers/USB/Class/Device/HIDClassDevice.h | 6 +++--- LUFA/Drivers/USB/USB.h | 4 ++++ 3 files changed, 13 insertions(+), 9 deletions(-) diff --git a/LUFA/DoxygenPages/Groups.txt b/LUFA/DoxygenPages/Groups.txt index e6ad884b6f..2dfa4209d4 100644 --- a/LUFA/DoxygenPages/Groups.txt +++ b/LUFA/DoxygenPages/Groups.txt @@ -6,33 +6,33 @@ /** \defgroup Group_BoardDrivers Board Drivers * - * Functions, macros, variables, enums and types related to the control of physical board hardware. + * \brief Functions, macros, variables, enums and types related to the control of physical board hardware. */ /** \defgroup Group_PeripheralDrivers On-chip Peripheral Drivers * - * Functions, macros, variables, enums and types related to the control of AVR subsystems. + * \brief Functions, macros, variables, enums and types related to the control of AVR subsystems. */ /** \defgroup Group_MiscDrivers Miscellaneous Drivers * - * Miscellaneous driver Functions, macros, variables, enums and types. + * \brief Miscellaneous driver Functions, macros, variables, enums and types. */ /** \defgroup Group_PlatformDrivers_AVR8 AVR8 * \ingroup Group_PlatformDrivers * - * Drivers relating to the AVR8 architecture platform, such as clock setup and interrupt management. + * \brief Drivers relating to the AVR8 architecture platform, such as clock setup and interrupt management. */ /** \defgroup Group_PlatformDrivers_XMEGA XMEGA * \ingroup Group_PlatformDrivers * - * Drivers relating to the XMEGA architecture platform, such as clock setup and interrupt management. + * \brief Drivers relating to the XMEGA architecture platform, such as clock setup and interrupt management. */ /** \defgroup Group_PlatformDrivers_UC3 UC3 * \ingroup Group_PlatformDrivers * - * Drivers relating to the UC3 architecture platform, such as clock setup and interrupt management. + * \brief Drivers relating to the UC3 architecture platform, such as clock setup and interrupt management. */ diff --git a/LUFA/Drivers/USB/Class/Device/HIDClassDevice.h b/LUFA/Drivers/USB/Class/Device/HIDClassDevice.h index e358dec756..41e9ab6df9 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 * must 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 512f7029f5..cabe71fdc9 100644 --- a/LUFA/Drivers/USB/USB.h +++ b/LUFA/Drivers/USB/USB.h @@ -38,6 +38,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: @@ -72,6 +74,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