From a8b66f318dda3cc18dfcedaa3af3d01ab68b82e8 Mon Sep 17 00:00:00 2001 From: Dean Camera Date: Sun, 26 Dec 2010 14:55:26 +0000 Subject: Documentation improvements - put driver example code into its own section, fix incorrect and missing section names. --- LUFA/Drivers/Board/Buttons.h | 7 +++++-- LUFA/Drivers/Board/Dataflash.h | 7 +++++-- LUFA/Drivers/Board/Joystick.h | 7 +++++-- LUFA/Drivers/Board/LEDs.h | 7 +++++-- LUFA/Drivers/Board/Temperature.h | 7 +++++-- LUFA/Drivers/Misc/RingBuffer.h | 7 +++++-- LUFA/Drivers/Misc/TerminalCodes.h | 12 +++++++++--- LUFA/Drivers/Peripheral/ADC.h | 2 +- LUFA/Drivers/Peripheral/AVRU4U6U7/ADC.h | 5 ++++- LUFA/Drivers/Peripheral/AVRU4U6U7/TWI.h | 5 ++++- LUFA/Drivers/Peripheral/SPI.h | 7 +++++-- LUFA/Drivers/Peripheral/Serial.h | 7 +++++-- LUFA/Drivers/Peripheral/SerialStream.h | 7 +++++-- LUFA/Drivers/Peripheral/TWI.h | 2 +- LUFA/Drivers/USB/Class/Audio.h | 2 +- LUFA/Drivers/USB/Class/CDC.h | 2 +- LUFA/Drivers/USB/Class/Common/Audio.h | 2 +- LUFA/Drivers/USB/Class/Common/CDC.h | 2 +- LUFA/Drivers/USB/Class/Common/HID.h | 2 +- LUFA/Drivers/USB/Class/Common/MIDI.h | 2 +- LUFA/Drivers/USB/Class/Common/MassStorage.h | 2 +- LUFA/Drivers/USB/Class/Common/Printer.h | 2 +- LUFA/Drivers/USB/Class/Common/RNDIS.h | 2 +- LUFA/Drivers/USB/Class/Common/StillImage.h | 2 +- LUFA/Drivers/USB/Class/Device/Audio.h | 2 +- LUFA/Drivers/USB/Class/Device/CDC.h | 2 +- LUFA/Drivers/USB/Class/Device/HID.h | 2 +- LUFA/Drivers/USB/Class/Device/MIDI.h | 2 +- LUFA/Drivers/USB/Class/Device/MassStorage.h | 2 +- LUFA/Drivers/USB/Class/Device/RNDIS.h | 2 +- LUFA/Drivers/USB/Class/HID.h | 2 +- LUFA/Drivers/USB/Class/Host/CDC.h | 2 +- LUFA/Drivers/USB/Class/Host/HID.h | 2 +- LUFA/Drivers/USB/Class/Host/HIDParser.h | 2 +- LUFA/Drivers/USB/Class/Host/MIDI.h | 2 +- LUFA/Drivers/USB/Class/Host/MassStorage.h | 2 +- LUFA/Drivers/USB/Class/Host/Printer.h | 2 +- LUFA/Drivers/USB/Class/Host/RNDIS.h | 2 +- LUFA/Drivers/USB/Class/Host/StillImage.h | 2 +- LUFA/Drivers/USB/Class/MIDI.h | 2 +- LUFA/Drivers/USB/Class/MassStorage.h | 2 +- LUFA/Drivers/USB/Class/Printer.h | 2 +- LUFA/Drivers/USB/Class/RNDIS.h | 2 +- LUFA/Drivers/USB/Class/StillImage.h | 2 +- LUFA/Drivers/USB/USB.h | 6 +++--- 45 files changed, 97 insertions(+), 58 deletions(-) (limited to 'LUFA/Drivers') diff --git a/LUFA/Drivers/Board/Buttons.h b/LUFA/Drivers/Board/Buttons.h index e112683a8..27a2f3c22 100644 --- a/LUFA/Drivers/Board/Buttons.h +++ b/LUFA/Drivers/Board/Buttons.h @@ -50,7 +50,7 @@ * The following files must be built with any user project that uses this module: * - None * - * \section Module Description + * \section Sec_ModDescription Module Description * Hardware buttons driver. This provides an easy to use driver for the hardware buttons present on many boards. * It provides a way to easily configure and check the status of all the buttons on the board so that appropriate * actions can be taken. @@ -60,7 +60,10 @@ * * For possible BOARD makefile values, see \ref Group_BoardTypes. * - * Example Usage: + * \section Sec_ExampleUsage Example Usage + * The following snippet is an example of how this module may be used within a typical + * application. + * * \code * // Initialise the button driver before first use * Buttons_Init(); diff --git a/LUFA/Drivers/Board/Dataflash.h b/LUFA/Drivers/Board/Dataflash.h index d443c8f5a..45654c000 100644 --- a/LUFA/Drivers/Board/Dataflash.h +++ b/LUFA/Drivers/Board/Dataflash.h @@ -50,7 +50,7 @@ * The following files must be built with any user project that uses this module: * - None * - * \section Module Description + * \section Sec_ModDescription Module Description * Dataflash driver. This module provides an easy to use interface for the Dataflash ICs located on many boards, * for the storage of large amounts of data into the Dataflash's non-volatile memory. * @@ -59,7 +59,10 @@ * * For possible BOARD makefile values, see \ref Group_BoardTypes. * - * Example Usage: + * \section Sec_ExampleUsage Example Usage + * The following snippet is an example of how this module may be used within a typical + * application. + * * \code * // Initialise the SPI and board Dataflash drivers before first use * SPI_Init(SPI_SPEED_FCPU_DIV_2 | SPI_ORDER_MSB_FIRST | SPI_SCK_LEAD_FALLING | diff --git a/LUFA/Drivers/Board/Joystick.h b/LUFA/Drivers/Board/Joystick.h index f3c5c9d26..81be0ea3f 100644 --- a/LUFA/Drivers/Board/Joystick.h +++ b/LUFA/Drivers/Board/Joystick.h @@ -50,7 +50,7 @@ * The following files must be built with any user project that uses this module: * - None * - * \section Module Description + * \section Sec_ModDescription Module Description * Hardware Joystick driver. This module provides an easy to use interface to control the hardware digital Joystick * located on many boards. * @@ -59,7 +59,10 @@ * * For possible BOARD makefile values, see \ref Group_BoardTypes. * - * Example Usage: + * \section Sec_ExampleUsage Example Usage + * The following snippet is an example of how this module may be used within a typical + * application. + * * \code * // Initialise the board Joystick driver before first use * Joystick_Init(); diff --git a/LUFA/Drivers/Board/LEDs.h b/LUFA/Drivers/Board/LEDs.h index b05d55cf8..8cd3037a3 100644 --- a/LUFA/Drivers/Board/LEDs.h +++ b/LUFA/Drivers/Board/LEDs.h @@ -50,7 +50,7 @@ * The following files must be built with any user project that uses this module: * - None * - * \section Module Description + * \section Sec_ModDescription Module Description * Hardware LEDs driver. This provides an easy to use driver for the hardware LEDs present on many boards. It * provides an interface to configure, test and change the status of all the board LEDs. * @@ -68,7 +68,10 @@ * compatible code for a board with no LEDs by making a board LED driver (see \ref Page_WritingBoardDrivers) * which contains only stub functions and defines no LEDs. * - * Example Usage: + * \section Sec_ExampleUsage Example Usage + * The following snippet is an example of how this module may be used within a typical + * application. + * * \code * // Initialise the board LED driver before first use * LEDs_Init(); diff --git a/LUFA/Drivers/Board/Temperature.h b/LUFA/Drivers/Board/Temperature.h index c8b36f586..fa86ccd24 100644 --- a/LUFA/Drivers/Board/Temperature.h +++ b/LUFA/Drivers/Board/Temperature.h @@ -41,13 +41,16 @@ * The following files must be built with any user project that uses this module: * - LUFA/Drivers/Board/Temperature.c (Makefile source module name: LUFA_SRC_TEMPERATURE) * - * \section Module Description + * \section Sec_ModDescription Module Description * Temperature sensor driver. This provides an easy to use interface for the hardware temperature sensor located * on many boards. It provides an interface to configure the sensor and appropriate ADC channel, plus read out the * current temperature in degrees C. It is designed for and will only work with the temperature sensor located on the * official Atmel USB AVR boards, as each sensor has different characteristics. * - * Example Usage: + * \section Sec_ExampleUsage Example Usage + * The following snippet is an example of how this module may be used within a typical + * application. + * * \code * // Initialise the ADC and board temperature sensor drivers before first use * ADC_Init(ADC_FREE_RUNNING | ADC_PRESCALE_128); diff --git a/LUFA/Drivers/Misc/RingBuffer.h b/LUFA/Drivers/Misc/RingBuffer.h index af6a69f83..3af5d8e44 100644 --- a/LUFA/Drivers/Misc/RingBuffer.h +++ b/LUFA/Drivers/Misc/RingBuffer.h @@ -47,7 +47,7 @@ * The following files must be built with any user project that uses this module: * - None * - * \section Module Description + * \section Sec_ModDescription Module Description * Lightweight ring buffer, for fast insertion/deletion. Multiple buffers can be created of * different sizes to suit different needs. * @@ -56,7 +56,10 @@ * or deletions) must not overlap. If there is possibility of two or more of the same kind of * operating occuring at the same point in time, atomic (mutex) locking should be used. * - * Example Usage: + * \section Sec_ExampleUsage Example Usage + * The following snippet is an example of how this module may be used within a typical + * application. + * * \code * // Create the buffer structure and its underlying storage array * RingBuff_t Buffer; diff --git a/LUFA/Drivers/Misc/TerminalCodes.h b/LUFA/Drivers/Misc/TerminalCodes.h index e1cba1674..0b82613d3 100644 --- a/LUFA/Drivers/Misc/TerminalCodes.h +++ b/LUFA/Drivers/Misc/TerminalCodes.h @@ -42,16 +42,22 @@ * The following files must be built with any user project that uses this module: * - None * - * \section Module Description + * \section Sec_ModDescription Module Description * Escape code macros for ANSI compliant text terminals. * * \note If desired, the macro DISABLE_TERMINAL_CODES can be defined in the project makefile and passed to the GCC * compiler via the -D switch to disable the terminal codes without modifying the source, for use with non * compatible terminals (any terminal codes then equate to empty strings). * - * Example Usage: + * \section Sec_ExampleUsage Example Usage + * The following snippet is an example of how this module may be used within a typical + * application. + * * \code - * printf("Some String, " ESC_BOLD_ON " Some bold string"); + * printf("Normal String, " + * ESC_BOLD_ON "Bold String, " + * ESC_UNDERLINE_ON "Bold and Underlined String" + * ESC_RESET ESC_FG_BLUE ESC_BG_YELLOW "Normal Blue-on-Yellow String"); * \endcode * * @{ diff --git a/LUFA/Drivers/Peripheral/ADC.h b/LUFA/Drivers/Peripheral/ADC.h index 0fba2d10e..79d2e89b1 100644 --- a/LUFA/Drivers/Peripheral/ADC.h +++ b/LUFA/Drivers/Peripheral/ADC.h @@ -44,7 +44,7 @@ * The following files must be built with any user project that uses this module: * - None * - * \section Module Description + * \section Sec_ModDescription Module Description * Hardware ADC driver. This module provides an easy to use driver for the hardware * ADC present on many AVR models, for the conversion of analogue signals into the * digital domain. diff --git a/LUFA/Drivers/Peripheral/AVRU4U6U7/ADC.h b/LUFA/Drivers/Peripheral/AVRU4U6U7/ADC.h index 3e736864c..8f3210a6c 100644 --- a/LUFA/Drivers/Peripheral/AVRU4U6U7/ADC.h +++ b/LUFA/Drivers/Peripheral/AVRU4U6U7/ADC.h @@ -47,7 +47,10 @@ * \note This file should not be included directly. It is automatically included as needed by the ADC driver * dispatch header located in LUFA/Drivers/Peripheral/ADC.h. * - * Example Usage: + * \section Sec_ExampleUsage Example Usage + * The following snippet is an example of how this module may be used within a typical + * application. + * * \code * // Initialise the ADC driver before first use * ADC_Init(ADC_FREE_RUNNING | ADC_PRESCALE_32); diff --git a/LUFA/Drivers/Peripheral/AVRU4U6U7/TWI.h b/LUFA/Drivers/Peripheral/AVRU4U6U7/TWI.h index c6fb42009..634ecc986 100644 --- a/LUFA/Drivers/Peripheral/AVRU4U6U7/TWI.h +++ b/LUFA/Drivers/Peripheral/AVRU4U6U7/TWI.h @@ -45,7 +45,10 @@ * \note This file should not be included directly. It is automatically included as needed by the TWI driver * dispatch header located in LUFA/Drivers/Peripheral/TWI.h. * - * Example Usage: + * \section Sec_ExampleUsage Example Usage + * The following snippet is an example of how this module may be used within a typical + * application. + * * \code * // Initialise the TWI driver before first use * TWI_Init(); diff --git a/LUFA/Drivers/Peripheral/SPI.h b/LUFA/Drivers/Peripheral/SPI.h index ff45bc3ae..f22b6d99a 100644 --- a/LUFA/Drivers/Peripheral/SPI.h +++ b/LUFA/Drivers/Peripheral/SPI.h @@ -41,11 +41,14 @@ * The following files must be built with any user project that uses this module: * - None * - * \section Module Description + * \section Sec_ModDescription Module Description * Driver for the hardware SPI port available on most AVR models. This module provides * an easy to use driver for the setup of and transfer of data over the AVR's SPI port. * - * Example Usage: + * \section Sec_ExampleUsage Example Usage + * The following snippet is an example of how this module may be used within a typical + * application. + * * \code * // Initialise the SPI driver before first use * SPI_Init(SPI_SPEED_FCPU_DIV_2 | SPI_ORDER_MSB_FIRST | SPI_SCK_LEAD_FALLING | diff --git a/LUFA/Drivers/Peripheral/Serial.h b/LUFA/Drivers/Peripheral/Serial.h index f40201de5..549448d92 100644 --- a/LUFA/Drivers/Peripheral/Serial.h +++ b/LUFA/Drivers/Peripheral/Serial.h @@ -41,11 +41,14 @@ * The following files must be built with any user project that uses this module: * - LUFA/Drivers/Peripheral/Serial.c (Makefile source module name: LUFA_SRC_SERIAL) * - * \section Module Description + * \section Sec_ModDescription Module Description * Hardware serial USART driver. This module provides an easy to use driver for * the setup of and transfer of data over the AVR's USART port. * - * Example Usage: + * \section Sec_ExampleUsage Example Usage + * The following snippet is an example of how this module may be used within a typical + * application. + * * \code * // Initialise the serial USART driver before first use, with 9600 baud (and no double-speed mode) * Serial_Init(9600, false); diff --git a/LUFA/Drivers/Peripheral/SerialStream.h b/LUFA/Drivers/Peripheral/SerialStream.h index bef52ac9e..3ea165066 100644 --- a/LUFA/Drivers/Peripheral/SerialStream.h +++ b/LUFA/Drivers/Peripheral/SerialStream.h @@ -44,13 +44,16 @@ * The following files must be built with any user project that uses this module: * - LUFA/Drivers/Peripheral/SerialStream.c (Makefile source module name: LUFA_SRC_SERIALSTREAM) * - * \section Module Description + * \section Sec_ModDescription Module Description * Serial stream driver for the USART subsystem on supported USB AVRs. This makes use of the functions in the * regular USART driver (see \ref Group_Serial), but allows the avr-libc standard stream functions (printf, * puts, etc.) to work with the USART. Upon configuration, this will redirect the standard input and output * streams to the USART. * - * Example Usage: + * \section Sec_ExampleUsage Example Usage + * The following snippet is an example of how this module may be used within a typical + * application. + * * \code * // Initialise the Serial Stream driver before first use, with 9600 baud (and no double-speed mode) * SerialStream_Init(9600, false); diff --git a/LUFA/Drivers/Peripheral/TWI.h b/LUFA/Drivers/Peripheral/TWI.h index e8cc834c8..5c2223e41 100644 --- a/LUFA/Drivers/Peripheral/TWI.h +++ b/LUFA/Drivers/Peripheral/TWI.h @@ -45,7 +45,7 @@ * - LUFA/Drivers/Peripheral/TWI.c (Makefile source module name: LUFA_SRC_TWI) * * - * \section Module Description + * \section Sec_ModDescription Module Description * Master Mode Hardware TWI driver. This module provides an easy to use driver for the hardware * TWI present on many AVR models, for the transmission and reception of data on a TWI bus. * diff --git a/LUFA/Drivers/USB/Class/Audio.h b/LUFA/Drivers/USB/Class/Audio.h index a33e98ed3..8ea5662dc 100644 --- a/LUFA/Drivers/USB/Class/Audio.h +++ b/LUFA/Drivers/USB/Class/Audio.h @@ -44,7 +44,7 @@ * The following files must be built with any user project that uses this module: * - LUFA/Drivers/USB/Class/Device/Audio.c (Makefile source module name: LUFA_SRC_USBCLASS) * - * \section Module Description + * \section Sec_ModDescription Module Description * Audio Class Driver module. This module contains an internal implementation of the USB Audio 1.0 Class, for Device * USB mode only. User applications can use this class driver instead of implementing the Audio class manually via * the low-level LUFA APIs. diff --git a/LUFA/Drivers/USB/Class/CDC.h b/LUFA/Drivers/USB/Class/CDC.h index 12aaf9362..fe45c2a22 100644 --- a/LUFA/Drivers/USB/Class/CDC.h +++ b/LUFA/Drivers/USB/Class/CDC.h @@ -45,7 +45,7 @@ * - LUFA/Drivers/USB/Class/Device/CDC.c (Makefile source module name: LUFA_SRC_USBCLASS) * - LUFA/Drivers/USB/Class/Host/CDC.c (Makefile source module name: LUFA_SRC_USBCLASS) * - * \section Module Description + * \section Sec_ModDescription Module Description * CDC Class Driver module. This module contains an internal implementation of the USB CDC-ACM class Virtual Serial * Ports, for both Device and Host USB modes. User applications can use this class driver instead of implementing the * CDC class manually via the low-level LUFA APIs. diff --git a/LUFA/Drivers/USB/Class/Common/Audio.h b/LUFA/Drivers/USB/Class/Common/Audio.h index c10e499ad..db3b10d9b 100644 --- a/LUFA/Drivers/USB/Class/Common/Audio.h +++ b/LUFA/Drivers/USB/Class/Common/Audio.h @@ -40,7 +40,7 @@ /** \ingroup Group_USBClassAudio * @defgroup Group_USBClassAudioCommon Common Class Definitions * - * \section Module Description + * \section Sec_ModDescription Module Description * Constants, Types and Enum definitions that are common to both Device and Host modes for the USB * Audio 1.0 Class. * diff --git a/LUFA/Drivers/USB/Class/Common/CDC.h b/LUFA/Drivers/USB/Class/Common/CDC.h index aaaf12144..3c9cee20f 100644 --- a/LUFA/Drivers/USB/Class/Common/CDC.h +++ b/LUFA/Drivers/USB/Class/Common/CDC.h @@ -40,7 +40,7 @@ /** \ingroup Group_USBClassCDC * @defgroup Group_USBClassCDCCommon Common Class Definitions * - * \section Module Description + * \section Sec_ModDescription Module Description * Constants, Types and Enum definitions that are common to both Device and Host modes for the USB * CDC Class. * diff --git a/LUFA/Drivers/USB/Class/Common/HID.h b/LUFA/Drivers/USB/Class/Common/HID.h index 024158aa3..017eb8249 100644 --- a/LUFA/Drivers/USB/Class/Common/HID.h +++ b/LUFA/Drivers/USB/Class/Common/HID.h @@ -40,7 +40,7 @@ /** \ingroup Group_USBClassHID * @defgroup Group_USBClassHIDCommon Common Class Definitions * - * \section Module Description + * \section Sec_ModDescription Module Description * Constants, Types and Enum definitions that are common to both Device and Host modes for the USB * HID Class. * diff --git a/LUFA/Drivers/USB/Class/Common/MIDI.h b/LUFA/Drivers/USB/Class/Common/MIDI.h index efab81820..fe43fe5ca 100644 --- a/LUFA/Drivers/USB/Class/Common/MIDI.h +++ b/LUFA/Drivers/USB/Class/Common/MIDI.h @@ -40,7 +40,7 @@ /** \ingroup Group_USBClassMIDI * @defgroup Group_USBClassMIDICommon Common Class Definitions * - * \section Module Description + * \section Sec_ModDescription Module Description * Constants, Types and Enum definitions that are common to both Device and Host modes for the USB * MIDI Class. * diff --git a/LUFA/Drivers/USB/Class/Common/MassStorage.h b/LUFA/Drivers/USB/Class/Common/MassStorage.h index 1e0c4546d..f7e31198b 100644 --- a/LUFA/Drivers/USB/Class/Common/MassStorage.h +++ b/LUFA/Drivers/USB/Class/Common/MassStorage.h @@ -40,7 +40,7 @@ /** \ingroup Group_USBClassMS * @defgroup Group_USBClassMSCommon Common Class Definitions * - * \section Module Description + * \section Sec_ModDescription Module Description * Constants, Types and Enum definitions that are common to both Device and Host modes for the USB * Mass Storage Class. * diff --git a/LUFA/Drivers/USB/Class/Common/Printer.h b/LUFA/Drivers/USB/Class/Common/Printer.h index 20a862daa..3a75183d4 100644 --- a/LUFA/Drivers/USB/Class/Common/Printer.h +++ b/LUFA/Drivers/USB/Class/Common/Printer.h @@ -40,7 +40,7 @@ /** \ingroup Group_USBClassPrinter * @defgroup Group_USBClassPrinterCommon Common Class Definitions * - * \section Module Description + * \section Sec_ModDescription Module Description * Constants, Types and Enum definitions that are common to both Device and Host modes for the USB * Printer Class. * diff --git a/LUFA/Drivers/USB/Class/Common/RNDIS.h b/LUFA/Drivers/USB/Class/Common/RNDIS.h index 79aae7f89..ead305153 100644 --- a/LUFA/Drivers/USB/Class/Common/RNDIS.h +++ b/LUFA/Drivers/USB/Class/Common/RNDIS.h @@ -40,7 +40,7 @@ /** \ingroup Group_USBClassRNDIS * @defgroup Group_USBClassRNDISCommon Common Class Definitions * - * \section Module Description + * \section Sec_ModDescription Module Description * Constants, Types and Enum definitions that are common to both Device and Host modes for the USB * RNDIS Class. * diff --git a/LUFA/Drivers/USB/Class/Common/StillImage.h b/LUFA/Drivers/USB/Class/Common/StillImage.h index c836b9137..64f5dd6fa 100644 --- a/LUFA/Drivers/USB/Class/Common/StillImage.h +++ b/LUFA/Drivers/USB/Class/Common/StillImage.h @@ -40,7 +40,7 @@ /** \ingroup Group_USBClassSI * @defgroup Group_USBClassSICommon Common Class Definitions * - * \section Module Description + * \section Sec_ModDescription Module Description * Constants, Types and Enum definitions that are common to both Device and Host modes for the USB * Still Image Class. * diff --git a/LUFA/Drivers/USB/Class/Device/Audio.h b/LUFA/Drivers/USB/Class/Device/Audio.h index 429b899c6..85e37e1c6 100644 --- a/LUFA/Drivers/USB/Class/Device/Audio.h +++ b/LUFA/Drivers/USB/Class/Device/Audio.h @@ -44,7 +44,7 @@ * The following files must be built with any user project that uses this module: * - LUFA/Drivers/USB/Class/Device/Audio.c (Makefile source module name: LUFA_SRC_USBCLASS) * - * \section Module Description + * \section Sec_ModDescription Module Description * Device Mode USB Class driver framework interface, for the Audio 1.0 USB Class driver. * * @{ diff --git a/LUFA/Drivers/USB/Class/Device/CDC.h b/LUFA/Drivers/USB/Class/Device/CDC.h index caea6ebc7..00ff8802c 100644 --- a/LUFA/Drivers/USB/Class/Device/CDC.h +++ b/LUFA/Drivers/USB/Class/Device/CDC.h @@ -44,7 +44,7 @@ * The following files must be built with any user project that uses this module: * - LUFA/Drivers/USB/Class/Device/CDC.c (Makefile source module name: LUFA_SRC_USBCLASS) * - * \section Module Description + * \section Sec_ModDescription Module Description * Device Mode USB Class driver framework interface, for the CDC USB Class driver. * * \note There are several major drawbacks to the CDC-ACM standard USB class, however diff --git a/LUFA/Drivers/USB/Class/Device/HID.h b/LUFA/Drivers/USB/Class/Device/HID.h index b9baf2900..07ffc2522 100644 --- a/LUFA/Drivers/USB/Class/Device/HID.h +++ b/LUFA/Drivers/USB/Class/Device/HID.h @@ -44,7 +44,7 @@ * The following files must be built with any user project that uses this module: * - LUFA/Drivers/USB/Class/Device/HID.c (Makefile source module name: LUFA_SRC_USBCLASS) * - * \section Module Description + * \section Sec_ModDescription Module Description * Device Mode USB Class driver framework interface, for the HID USB Class driver. * * @{ diff --git a/LUFA/Drivers/USB/Class/Device/MIDI.h b/LUFA/Drivers/USB/Class/Device/MIDI.h index 4f72d5c93..6b93cb0e7 100644 --- a/LUFA/Drivers/USB/Class/Device/MIDI.h +++ b/LUFA/Drivers/USB/Class/Device/MIDI.h @@ -44,7 +44,7 @@ * The following files must be built with any user project that uses this module: * - LUFA/Drivers/USB/Class/Device/MIDI.c (Makefile source module name: LUFA_SRC_USBCLASS) * - * \section Module Description + * \section Sec_ModDescription Module Description * Device Mode USB Class driver framework interface, for the MIDI USB Class driver. * * @{ diff --git a/LUFA/Drivers/USB/Class/Device/MassStorage.h b/LUFA/Drivers/USB/Class/Device/MassStorage.h index 57b145e38..ba7654692 100644 --- a/LUFA/Drivers/USB/Class/Device/MassStorage.h +++ b/LUFA/Drivers/USB/Class/Device/MassStorage.h @@ -44,7 +44,7 @@ * The following files must be built with any user project that uses this module: * - LUFA/Drivers/USB/Class/Device/MassStorage.c (Makefile source module name: LUFA_SRC_USBCLASS) * - * \section Module Description + * \section Sec_ModDescription Module Description * Device Mode USB Class driver framework interface, for the Mass Storage USB Class driver. * * @{ diff --git a/LUFA/Drivers/USB/Class/Device/RNDIS.h b/LUFA/Drivers/USB/Class/Device/RNDIS.h index 292c51b77..66bb43c61 100644 --- a/LUFA/Drivers/USB/Class/Device/RNDIS.h +++ b/LUFA/Drivers/USB/Class/Device/RNDIS.h @@ -44,7 +44,7 @@ * The following files must be built with any user project that uses this module: * - LUFA/Drivers/USB/Class/Device/RNDIS.c (Makefile source module name: LUFA_SRC_USBCLASS) * - * \section Module Description + * \section Sec_ModDescription Module Description * Device Mode USB Class driver framework interface, for the RNDIS USB Class driver. * * @{ diff --git a/LUFA/Drivers/USB/Class/HID.h b/LUFA/Drivers/USB/Class/HID.h index a01370e57..91c0090b8 100644 --- a/LUFA/Drivers/USB/Class/HID.h +++ b/LUFA/Drivers/USB/Class/HID.h @@ -46,7 +46,7 @@ * - LUFA/Drivers/USB/Class/Host/HID.c (Makefile source module name: LUFA_SRC_USBCLASS) * - LUFA/Drivers/USB/Class/Host/HIDParser.c (Makefile source module name: LUFA_SRC_USB) * - * \section Module Description + * \section Sec_ModDescription Module Description * HID Class Driver module. This module contains an internal implementation of the USB HID Class, for both Device * and Host USB modes. User applications can use this class driver instead of implementing the HID class manually * via the low-level LUFA APIs. diff --git a/LUFA/Drivers/USB/Class/Host/CDC.h b/LUFA/Drivers/USB/Class/Host/CDC.h index 016f4a5d1..2aa46de1b 100644 --- a/LUFA/Drivers/USB/Class/Host/CDC.h +++ b/LUFA/Drivers/USB/Class/Host/CDC.h @@ -44,7 +44,7 @@ * The following files must be built with any user project that uses this module: * - LUFA/Drivers/USB/Class/Host/CDC.c (Makefile source module name: LUFA_SRC_USBCLASS) * - * \section Module Description + * \section Sec_ModDescription Module Description * Host Mode USB Class driver framework interface, for the CDC USB Class driver. * * @{ diff --git a/LUFA/Drivers/USB/Class/Host/HID.h b/LUFA/Drivers/USB/Class/Host/HID.h index d1392c94b..f00cdc943 100644 --- a/LUFA/Drivers/USB/Class/Host/HID.h +++ b/LUFA/Drivers/USB/Class/Host/HID.h @@ -45,7 +45,7 @@ * - LUFA/Drivers/USB/Class/Host/HID.c (Makefile source module name: LUFA_SRC_USBCLASS) * - LUFA/Drivers/USB/Class/Host/HIDParser.c (Makefile source module name: LUFA_SRC_USB) * - * \section Module Description + * \section Sec_ModDescription Module Description * Host Mode USB Class driver framework interface, for the HID USB Class driver. * * @{ diff --git a/LUFA/Drivers/USB/Class/Host/HIDParser.h b/LUFA/Drivers/USB/Class/Host/HIDParser.h index df259591d..5ec2b55fa 100644 --- a/LUFA/Drivers/USB/Class/Host/HIDParser.h +++ b/LUFA/Drivers/USB/Class/Host/HIDParser.h @@ -43,7 +43,7 @@ * The following files must be built with any user project that uses this module: * - LUFA/Drivers/USB/Class/Host/HIDParser.c (Makefile source module name: LUFA_SRC_USB) * - * \section Module Description + * \section Sec_ModDescription Module Description * Functions, macros, variables, enums and types related to the parsing of HID class device report descriptors. * * The processed HID report is presented back to the user application as a flat structure containing each report diff --git a/LUFA/Drivers/USB/Class/Host/MIDI.h b/LUFA/Drivers/USB/Class/Host/MIDI.h index 7ac4ab7c4..f0b4a27a2 100644 --- a/LUFA/Drivers/USB/Class/Host/MIDI.h +++ b/LUFA/Drivers/USB/Class/Host/MIDI.h @@ -44,7 +44,7 @@ * The following files must be built with any user project that uses this module: * - LUFA/Drivers/USB/Class/Host/MIDI.c (Makefile source module name: LUFA_SRC_USBCLASS) * - * \section Module Description + * \section Sec_ModDescription Module Description * Host Mode USB Class driver framework interface, for the MIDI USB Class driver. * * @{ diff --git a/LUFA/Drivers/USB/Class/Host/MassStorage.h b/LUFA/Drivers/USB/Class/Host/MassStorage.h index 5779a4721..4a4ae7809 100644 --- a/LUFA/Drivers/USB/Class/Host/MassStorage.h +++ b/LUFA/Drivers/USB/Class/Host/MassStorage.h @@ -44,7 +44,7 @@ * The following files must be built with any user project that uses this module: * - LUFA/Drivers/USB/Class/Host/MassStorage.c (Makefile source module name: LUFA_SRC_USBCLASS) * - * \section Module Description + * \section Sec_ModDescription Module Description * Host Mode USB Class driver framework interface, for the Mass Storage USB Class driver. * * @{ diff --git a/LUFA/Drivers/USB/Class/Host/Printer.h b/LUFA/Drivers/USB/Class/Host/Printer.h index 99df01fa4..bc41bafda 100644 --- a/LUFA/Drivers/USB/Class/Host/Printer.h +++ b/LUFA/Drivers/USB/Class/Host/Printer.h @@ -44,7 +44,7 @@ * The following files must be built with any user project that uses this module: * - LUFA/Drivers/USB/Class/Host/Printer.c (Makefile source module name: LUFA_SRC_USBCLASS) * - * \section Module Description + * \section Sec_ModDescription Module Description * Host Mode USB Class driver framework interface, for the Printer USB Class driver. * * @{ diff --git a/LUFA/Drivers/USB/Class/Host/RNDIS.h b/LUFA/Drivers/USB/Class/Host/RNDIS.h index 6eaf131ea..32d4e585e 100644 --- a/LUFA/Drivers/USB/Class/Host/RNDIS.h +++ b/LUFA/Drivers/USB/Class/Host/RNDIS.h @@ -44,7 +44,7 @@ * The following files must be built with any user project that uses this module: * - LUFA/Drivers/USB/Class/Host/RNDIS.c (Makefile source module name: LUFA_SRC_USBCLASS) * - * \section Module Description + * \section Sec_ModDescription Module Description * Host Mode USB Class driver framework interface, for the Microsoft RNDIS Ethernet * USB Class driver. * diff --git a/LUFA/Drivers/USB/Class/Host/StillImage.h b/LUFA/Drivers/USB/Class/Host/StillImage.h index 39ab65ddf..3bbf71000 100644 --- a/LUFA/Drivers/USB/Class/Host/StillImage.h +++ b/LUFA/Drivers/USB/Class/Host/StillImage.h @@ -44,7 +44,7 @@ * The following files must be built with any user project that uses this module: * - LUFA/Drivers/USB/Class/Host/StillImage.c (Makefile source module name: LUFA_SRC_USBCLASS) * - * \section Module Description + * \section Sec_ModDescription Module Description * Host Mode USB Class driver framework interface, for the Still Image USB Class driver. * * @{ diff --git a/LUFA/Drivers/USB/Class/MIDI.h b/LUFA/Drivers/USB/Class/MIDI.h index 9d00e2b0c..f3062a1b0 100644 --- a/LUFA/Drivers/USB/Class/MIDI.h +++ b/LUFA/Drivers/USB/Class/MIDI.h @@ -45,7 +45,7 @@ * - LUFA/Drivers/USB/Class/Device/MIDI.c (Makefile source module name: LUFA_SRC_USBCLASS) * - LUFA/Drivers/USB/Class/Host/MIDI.c (Makefile source module name: LUFA_SRC_USBCLASS) * - * \section Module Description + * \section Sec_ModDescription Module Description * MIDI Class Driver module. This module contains an internal implementation of the USB MIDI Class, for both Device * and Host USB modes. User applications can use this class driver instead of implementing the MIDI class manually * via the low-level LUFA APIs. diff --git a/LUFA/Drivers/USB/Class/MassStorage.h b/LUFA/Drivers/USB/Class/MassStorage.h index 31b1dac65..5b60dad2a 100644 --- a/LUFA/Drivers/USB/Class/MassStorage.h +++ b/LUFA/Drivers/USB/Class/MassStorage.h @@ -45,7 +45,7 @@ * - LUFA/Drivers/USB/Class/Device/MassStorage.c (Makefile source module name: LUFA_SRC_USBCLASS) * - LUFA/Drivers/USB/Class/Host/MassStorage.c (Makefile source module name: LUFA_SRC_USBCLASS) * - * \section Module Description + * \section Sec_ModDescription Module Description * Mass Storage Class Driver module. This module contains an internal implementation of the USB Mass Storage Class, for both * Device and Host USB modes. User applications can use this class driver instead of implementing the Mass Storage class * manually via the low-level LUFA APIs. diff --git a/LUFA/Drivers/USB/Class/Printer.h b/LUFA/Drivers/USB/Class/Printer.h index ec10197c5..d933eebc2 100644 --- a/LUFA/Drivers/USB/Class/Printer.h +++ b/LUFA/Drivers/USB/Class/Printer.h @@ -44,7 +44,7 @@ * The following files must be built with any user project that uses this module: * - LUFA/Drivers/USB/Class/Host/Printer.c (Makefile source module name: LUFA_SRC_USBCLASS) * - * \section Module Description + * \section Sec_ModDescription Module Description * Printer Class Driver module. This module contains an internal implementation of the USB Printer Class, for the base * USB Printer transport layer for USB Host mode only. Note that printers are free to implement whatever printer language * they choose on top of this (e.g. Postscript), and so this driver exposes low level data transport functions only rather diff --git a/LUFA/Drivers/USB/Class/RNDIS.h b/LUFA/Drivers/USB/Class/RNDIS.h index 6a0fbe5a5..44f3f6fb6 100644 --- a/LUFA/Drivers/USB/Class/RNDIS.h +++ b/LUFA/Drivers/USB/Class/RNDIS.h @@ -45,7 +45,7 @@ * - LUFA/Drivers/USB/Class/Device/RNDIS.c (Makefile source module name: LUFA_SRC_USBCLASS) * - LUFA/Drivers/USB/Class/Host/RNDIS.c (Makefile source module name: LUFA_SRC_USBCLASS) * - * \section Module Description + * \section Sec_ModDescription Module Description * RNDIS Class Driver module. This module contains an internal implementation of the Microsoft USB RNDIS Networking * Class, for both Device and Host USB modes. User applications can use this class driver instead of implementing the * RNDIS class manually via the low-level LUFA APIs. diff --git a/LUFA/Drivers/USB/Class/StillImage.h b/LUFA/Drivers/USB/Class/StillImage.h index 5d587a95a..5835428d9 100644 --- a/LUFA/Drivers/USB/Class/StillImage.h +++ b/LUFA/Drivers/USB/Class/StillImage.h @@ -44,7 +44,7 @@ * The following files must be built with any user project that uses this module: * - LUFA/Drivers/USB/Class/Host/StillImage.c (Makefile source module name: LUFA_SRC_USBCLASS) * - * \section Module Description + * \section Sec_ModDescription Module Description * Still Image Class Driver module. This module contains an internal implementation of the USB Still Image Class, * for USB Host mode only. User applications can use this class driver instead of implementing the Still Image class * manually via the low-level LUFA APIs. diff --git a/LUFA/Drivers/USB/USB.h b/LUFA/Drivers/USB/USB.h index fcb74006f..731704ea8 100644 --- a/LUFA/Drivers/USB/USB.h +++ b/LUFA/Drivers/USB/USB.h @@ -55,7 +55,7 @@ * - LUFA/Drivers/USB/HighLevel/PipeStream.c (Makefile source module name: LUFA_SRC_USB) * - LUFA/Drivers/USB/HighLevel/USBTask.c (Makefile source module name: LUFA_SRC_USB) * - * \section Module Description + * \section Sec_ModDescription Module Description * Driver and framework for the USB controller hardware on the USB series of AVR microcontrollers. This module * consists of many submodules, and is designed to provide an easy way to configure and control USB host, device * or OTG mode USB applications. @@ -139,7 +139,7 @@ * slightly differently, and thus will be explained separately. For information on a specific class driver, read * the class driver's module documentation. * - * \subsection SSec_ClassDriverDevice Device Mode Class Drivers + * \subsection Sec_ClassDriverDevice Device Mode Class Drivers * Implementing a Device Mode Class Driver in a user application requires a number of steps to be followed. Firstly, * the module configuration and state structure must be added to the project source. These structures are named in a * similar manner between classes, that of USB_ClassInfo_{Class Name}_Device_t, and are used to hold the @@ -238,7 +238,7 @@ * read and write routines. See each driver's individual documentation for more information on the * class-specific functions. * - * \subsection SSec_ClassDriverHost Host Mode Class Drivers + * \subsection Sec_ClassDriverHost Host Mode Class Drivers * Implementing a Host Mode Class Driver in a user application requires a number of steps to be followed. Firstly, * the module configuration and state structure must be added to the project source. These structures are named in a * similar manner between classes, that of USB_ClassInfo_{Class Name}_Host_t, and are used to hold the -- cgit v1.2.3