diff options
65 files changed, 173 insertions, 173 deletions
diff --git a/LUFA/DoxygenPages/BuildSystem.txt b/LUFA/DoxygenPages/BuildSystem.txt index e8f0e5bec..8a498a335 100644 --- a/LUFA/DoxygenPages/BuildSystem.txt +++ b/LUFA/DoxygenPages/BuildSystem.txt @@ -6,14 +6,14 @@ /** \page Page_BuildSystem The LUFA Build System
*
- * \section Sec_BuildSystemOverview Overview of the LUFA Build System
+ * \section Sec_BuildSystem_Overview Overview of the LUFA Build System
* The LUFA build system is an attempt at making a set of re-usable, modular build make files which
* can be referenced in a LUFA powered project, to minimize the amount of code required in an
* application makefile. The system is written in GNU Make, and each module is independent of
* one-another.
*
* For details on the prerequisites needed for Linux and Windows machines to be able to use the LUFA
- * build system, see \ref Sec_Prerequisites.
+ * build system, see \ref Sec_CompilingApps_Prerequisites.
*
* To use a LUFA build system module, simply add an include to your project makefile. All user projects
* should at a minimum include \ref Page_BuildModule_CORE for base functionality:
@@ -25,13 +25,13 @@ * project's build makefile targets automatically. To call a build target, run <tt>make {TARGET_NAME}</tt>
* from the command line, substituting in the appropriate target name.
*
- * \see \ref Sec_AppMakefileParams for a copy of the sample LUFA project makefile.
+ * \see \ref Sec_ConfiguringApps_AppMakefileParams for a copy of the sample LUFA project makefile.
*
* Each build module may have one or more mandatory parameters (GNU Make variables) which <i>must</i>
* be supplied in the project makefile for the module to work, and one or more optional parameters which
* may be defined and which will assume a sensible default if not.
*
- * \section SSec_BuildSystemModules Available Modules
+ * \section SSec_BuildSystem_Modules Available Modules
*
* The following modules are included in this LUFA release:
*
diff --git a/LUFA/DoxygenPages/CompileTimeTokens.txt b/LUFA/DoxygenPages/CompileTimeTokens.txt index f58eb5c39..ab075cff7 100644 --- a/LUFA/DoxygenPages/CompileTimeTokens.txt +++ b/LUFA/DoxygenPages/CompileTimeTokens.txt @@ -14,7 +14,7 @@ * in the user directory where the below compile time tokens may be defined. This allows for an alternative to makefile * defined tokens for configuring the library. * - * \section Sec_SummaryNonUSBTokens Non USB Related Tokens + * \section Sec_TokenSummary_NonUSBTokens Non USB Related Tokens * This section describes compile tokens which affect non-USB sections of the LUFA library. * * \li <b>DISABLE_TERMINAL_CODES</b> - (\ref Group_Terminal) - <i>All Architectures</i> \n @@ -24,7 +24,7 @@ * the source code at compile time. * * - * \section Sec_SummaryUSBClassTokens USB Class Driver Related Tokens + * \section Sec_TokenSummary_USBClassTokens USB Class Driver Related Tokens * This section describes compile tokens which affect USB class-specific drivers in the LUFA library. * * \li <b>HID_HOST_BOOT_PROTOCOL_ONLY</b> - (\ref Group_USBClassHIDHost) - <i>All Architectures</i> \n @@ -78,7 +78,7 @@ * management tasks. * * - * \section Sec_SummaryUSBTokens General USB Driver Related Tokens + * \section Sec_TokenSummary_USBTokens General USB Driver Related Tokens * This section describes compile tokens which affect USB driver stack as a whole in the LUFA library. * * \li <b>ORDERED_EP_CONFIG</b> - (\ref Group_EndpointManagement , \ref Group_PipeManagement) - <i>AVR8, UC3</i> \n @@ -124,7 +124,7 @@ * reducing the compiled program's binary size. * * - * \section Sec_SummaryUSBDeviceTokens USB Device Mode Driver Related Tokens + * \section Sec_TokenSummary_USBDeviceTokens USB Device Mode Driver Related Tokens * This section describes compile tokens which affect USB driver stack of the LUFA library when used in Device mode. * * \li <b>USE_RAM_DESCRIPTORS</b> - (\ref Group_StdDescriptors) - <i>AVR8 Only</i> \n @@ -188,7 +188,7 @@ * and the code required to manage it may be disabled by passing this token to the library via the -D switch. * * - * \section Sec_SummaryUSBHostTokens USB Host Mode Driver Related Tokens + * \section Sec_TokenSummary_USBHostTokens USB Host Mode Driver Related Tokens * * This section describes compile tokens which affect USB driver stack of the LUFA library when used in Host mode. * diff --git a/LUFA/DoxygenPages/CompilingApps.txt b/LUFA/DoxygenPages/CompilingApps.txt index f41b80517..08f81d2ba 100644 --- a/LUFA/DoxygenPages/CompilingApps.txt +++ b/LUFA/DoxygenPages/CompilingApps.txt @@ -8,12 +8,12 @@ * * The following details how to compile the included LUFA demos, applications and bootloaders using AVR-GCC. * - * \section Sec_Prerequisites Prerequisites + * \section Sec_CompilingApps_Prerequisites Prerequisites * Before you can compile any of the LUFA library code or demos, you will need a recent distribution of avr-libc (1.6.2+) * and the AVR-GCC (4.2+) compiler. A standard "coreutils" package for your system is also required for command line * compilation of LUFA based applications. * - * \subsection SSec_PreqWindows Windows Prerequisites + * \subsection SSec_CompilingApps_PreqWindows Windows Prerequisites * On Windows, you will need a copy of the latest Atmel Toolchain (<a>http://www.atmel.com/tools/ATMELAVRTOOLCHAINFORWINDOWS.aspx</a>), * either downloaded and installed as a standalone package, or installed as part of Atmel Studio. You will need to ensure * that the "bin" directory of the toolchain is available in your system's <b>PATH</b> environment variable. @@ -23,12 +23,12 @@ * of the MinGW installer (<a>http://www.mingw.org</a>). Once installed, add the "msys\1.0\bin" of the MinGW installation * folder is added to your system's <b>PATH</b> environment variable. * - * \subsection SSec_PreqLinux Linux Prerequisites + * \subsection SSec_CompilingApps_PreqLinux Linux Prerequisites * On Linux systems you will need to install the latest Linux distribution of the standalone Atmel Toolchain from the * Atmel website (<a>http://www.atmel.com/tools/ATMELAVRTOOLCHAINFORLINUX.aspx</a>), or use the latest avr-libc and avr-gcc packages * for your chosen distribution's package manager. For full device support, the Atmel standalone Toolchain package is recommended. * - * \section Sec_Compiling Compiling a LUFA Application + * \section Sec_CompilingApps_Compiling Compiling a LUFA Application * Compiling the LUFA demos, applications and/or bootloaders is very simple. LUFA comes with makefile scripts for * each individual demo, bootloader and project folder, as well as scripts in the Demos/, Bootloaders/, Projects/ * and the LUFA root directory. Compilation of projects can be started from any of the above directories, with a build diff --git a/LUFA/DoxygenPages/ConfiguringApps.txt b/LUFA/DoxygenPages/ConfiguringApps.txt index ece9dd59b..171198e4e 100644 --- a/LUFA/DoxygenPages/ConfiguringApps.txt +++ b/LUFA/DoxygenPages/ConfiguringApps.txt @@ -18,7 +18,7 @@ * * \see \ref Page_BuildSystem for information on the LUFA build system. * - * \section Sec_AppMakefileParams The Default Application Makefile Template + * \section Sec_ConfiguringApps_AppMakefileParams The Default Application Makefile Template * * Below is a copy of the default LUFA application makefile, which can be used as a template for each application. * @@ -41,21 +41,21 @@ * * These values should be changed to reflect the build hardware. * - * \subsection SSec_MCU The MCU Parameter + * \subsection SSec_ConfiguringApps_MCU The MCU Parameter * This parameter indicates the target microcontroller model for the compiled application. This should be set to the model of the target * microcontroller (such as the AT90USB1287, or the ATMEGA32U4), in all lower-case (e.g. "at90usb1287"). Note that not all demos support all the * microcontroller models and architectures, as they may make use of peripherals or modes only present in some devices. * * For supported processor models, see \ref Page_DeviceSupport. * - * \subsection SSec_ARCH The ARCH Parameter + * \subsection SSec_ConfiguringApps_ARCH The ARCH Parameter * This parameter indicates the target microcontroller architecture the library is to be compiled for. Different microcontroller * architectures require different source files to be compiled into the final binary, and so this option must be set to the correct * architecture for the selected platform. * * For supported processor architectures, see \ref Page_DeviceSupport. * - * \subsection SSec_BOARD The BOARD Parameter + * \subsection SSec_ConfiguringApps_BOARD The BOARD Parameter * This parameter indicates the target board hardware for the compiled application. Some LUFA library drivers are board-specific, * such as the LED driver, and the library needs to know the layout of the target board. If you are using one of the board models listed * on the main library page, change this parameter to the board name in all UPPER-case. @@ -68,37 +68,37 @@ * * For boards with built in hardware driver support within the LUFA library, see \ref Page_DeviceSupport. * - * \subsection SSec_F_CPU The F_CPU Parameter + * \subsection SSec_ConfiguringApps_F_CPU The F_CPU Parameter * This parameter indicates the target microcontroller's main CPU clock frequency, in Hz. This is used by many libraries (and applications) for * timing related purposes, and should reflect the actual CPU speed after any prescaling or adjustments are performed. * - * \subsection SSec_F_USB The F_USB Parameter + * \subsection SSec_ConfiguringApps_F_USB The F_USB Parameter * This parameter indicates the raw input clock frequency to the USB module within the microcontroller in Hz. This may be very different on some platforms * to the main CPU clock or other peripheral/bus clocks. * - * \subsection SSec_OPTIMIZATION The OPTIMIZATION Parameter + * \subsection SSec_ConfiguringApps_OPTIMIZATION The OPTIMIZATION Parameter * This parameter indicates the level of optimization to use when compiling the application. This will allow you to compile with an optimization level * supported by GCC, from <tt>0</tt> (no optimization) to <tt>3</tt> (fastest runtime optimization) or <tt>s</tt> (smallest size). * - * \subsection SSec_TARGET The TARGET Parameter + * \subsection SSec_ConfiguringApps_TARGET The TARGET Parameter * This parameter indicates the application target name, which is used as the base filename for the build binary and debugging files. This will be the * name of the output files once linked together into the final application, ready to load into the target. * - * \subsection SSec_SRC The SRC Parameter + * \subsection SSec_ConfiguringApps_SRC The SRC Parameter * This parameter indicates the source files used to compile the application, as a list of C (<tt>*.c</tt>), C++ (<tt>*.cpp</tt>) and Assembly (<tt>*.S</tt>) files. Note that * all assembly files must end in a <b>capital</b> .S extension, as lowercase .s files are reserved for GCC intermediate files. * - * \subsection SSec_LUFA_PATH The LUFA_PATH Parameter + * \subsection SSec_ConfiguringApps_LUFA_PATH The LUFA_PATH Parameter * As each LUFA program requires the LUFA library source code to compile correctly, the application must know where the LUFA library is located. This * value specifies the path to the LUFA library core. This path may be relative or absolute, however note than even under Windows based systems the * forward-slash (/) path seperator must be used. * - * \subsection SSec_CC_FLAGS The CC_FLAGS Parameter + * \subsection SSec_ConfiguringApps_CC_FLAGS The CC_FLAGS Parameter * This parameter lists the compiler flags passed to the C/C++ compiler, the assembler and the linker. These are used as-is directly to GCC and thus * must match GCC's command line options as given in the GCC manual. This variable may be used to define tokens directly on the command line, enable or * disable warnings, adjust the target-specific tuning parameters or other options. * - * \subsection SSec_LD_FLAGS The LD_FLAGS Parameter + * \subsection SSec_ConfiguringApps_LD_FLAGS The LD_FLAGS Parameter * This parameter lists the linker flags passed exclusively to the linker. These are used as-is directly to GCC and thus must match GCC's command line * linker options as given in the GCC manual. This variable may be used to create or relocate custom data sections, or enable linker specific behaviors. */ diff --git a/LUFA/Drivers/Board/Board.h b/LUFA/Drivers/Board/Board.h index 1f36470d2..1a6595a82 100644 --- a/LUFA/Drivers/Board/Board.h +++ b/LUFA/Drivers/Board/Board.h @@ -47,7 +47,7 @@ * \defgroup Group_BoardInfo Board Information Driver - LUFA/Drivers/Board/Board.h * \brief Board hardware information driver. * - * \section Sec_Dependencies Module Source Dependencies + * \section Sec_BoardInfo_Dependencies Module Source Dependencies * The following files must be built with any user project that uses this module: * - None * diff --git a/LUFA/Drivers/Board/Buttons.h b/LUFA/Drivers/Board/Buttons.h index 395d7901a..75d5ec3db 100644 --- a/LUFA/Drivers/Board/Buttons.h +++ b/LUFA/Drivers/Board/Buttons.h @@ -47,11 +47,11 @@ * \defgroup Group_Buttons Buttons Driver - LUFA/Drivers/Board/Buttons.h * \brief Digital button board hardware driver. * - * \section Sec_Dependencies Module Source Dependencies + * \section Sec_Buttons_Dependencies Module Source Dependencies * The following files must be built with any user project that uses this module: * - None * - * \section Sec_ModDescription Module Description + * \section Sec_Buttons_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. @@ -61,7 +61,7 @@ * * For possible \c BOARD makefile values, see \ref Group_BoardTypes. * - * \section Sec_ExampleUsage Example Usage + * \section Sec_Buttons_ExampleUsage Example Usage * The following snippet is an example of how this module may be used within a typical * application. * diff --git a/LUFA/Drivers/Board/Dataflash.h b/LUFA/Drivers/Board/Dataflash.h index 7b99371ed..91b667be8 100644 --- a/LUFA/Drivers/Board/Dataflash.h +++ b/LUFA/Drivers/Board/Dataflash.h @@ -48,11 +48,11 @@ * \defgroup Group_Dataflash Dataflash Driver - LUFA/Drivers/Board/Dataflash.h * \brief Atmel Dataflash storage IC board hardware driver. * - * \section Sec_Dependencies Module Source Dependencies + * \section Sec_Dataflash_Dependencies Module Source Dependencies * The following files must be built with any user project that uses this module: * - None * - * \section Sec_ModDescription Module Description + * \section Sec_Dataflash_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. * @@ -61,7 +61,7 @@ * * For possible \c BOARD makefile values, see \ref Group_BoardTypes. * - * \section Sec_ExampleUsage Example Usage + * \section Sec_Dataflash_ExampleUsage Example Usage * The following snippet is an example of how this module may be used within a typical * application. * diff --git a/LUFA/Drivers/Board/Joystick.h b/LUFA/Drivers/Board/Joystick.h index c3b306e06..5ffabfadc 100644 --- a/LUFA/Drivers/Board/Joystick.h +++ b/LUFA/Drivers/Board/Joystick.h @@ -47,11 +47,11 @@ * \defgroup Group_Joystick Joystick Driver - LUFA/Drivers/Board/Joystick.h * \brief Digital joystick board hardware driver. * - * \section Sec_Dependencies Module Source Dependencies + * \section Sec_Joystick_Dependencies Module Source Dependencies * The following files must be built with any user project that uses this module: * - None * - * \section Sec_ModDescription Module Description + * \section Sec_Joystick_ModDescription Module Description * Hardware Joystick driver. This module provides an easy to use interface to control the hardware digital Joystick * located on many boards. * @@ -60,7 +60,7 @@ * * For possible \c BOARD makefile values, see \ref Group_BoardTypes. * - * \section Sec_ExampleUsage Example Usage + * \section Sec_Joystick_ExampleUsage Example Usage * The following snippet is an example of how this module may be used within a typical * application. * diff --git a/LUFA/Drivers/Board/LEDs.h b/LUFA/Drivers/Board/LEDs.h index 3c5ceefa3..e83832c68 100644 --- a/LUFA/Drivers/Board/LEDs.h +++ b/LUFA/Drivers/Board/LEDs.h @@ -47,11 +47,11 @@ * \defgroup Group_LEDs LEDs Driver - LUFA/Drivers/Board/LEDs.h * \brief LED board hardware driver. * - * \section Sec_Dependencies Module Source Dependencies + * \section Sec_LEDs_Dependencies Module Source Dependencies * The following files must be built with any user project that uses this module: * - None * - * \section Sec_ModDescription Module Description + * \section Sec_LEDs_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. * @@ -69,7 +69,7 @@ * 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. * - * \section Sec_ExampleUsage Example Usage + * \section Sec_LEDs_ExampleUsage Example Usage * The following snippet is an example of how this module may be used within a typical * application. * diff --git a/LUFA/Drivers/Board/Temperature.h b/LUFA/Drivers/Board/Temperature.h index fef38fc0d..229dfae12 100644 --- a/LUFA/Drivers/Board/Temperature.h +++ b/LUFA/Drivers/Board/Temperature.h @@ -38,17 +38,17 @@ * \defgroup Group_Temperature Temperature Sensor Driver - LUFA/Drivers/Board/Temperature.h * \brief NTC Temperature Sensor board hardware driver. * - * \section Sec_Dependencies Module Source Dependencies + * \section Sec_Temperature_Dependencies Module Source Dependencies * The following files must be built with any user project that uses this module: * - LUFA/Drivers/Board/Temperature.c <i>(Makefile source module name: LUFA_SRC_TEMPERATURE)</i> * - * \section Sec_ModDescription Module Description + * \section Sec_Temperature_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. * - * \section Sec_ExampleUsage Example Usage + * \section Sec_Temperature_ExampleUsage Example Usage * The following snippet is an example of how this module may be used within a typical * application. * @@ -56,7 +56,7 @@ * // Initialize the ADC and board temperature sensor drivers before first use * ADC_Init(ADC_FREE_RUNNING | ADC_PRESCALE_128); * Temperature_Init(); - * + * * // Display converted temperature in degrees Celsius * printf("Current Temperature: %d Degrees\r\n", Temperature_GetTemperature()); * \endcode @@ -75,7 +75,7 @@ (BOARD == BOARD_STK526) || (BOARD == BOARD_EVK527)) #define TEMPERATURE_SENSOR_DRIVER_COMPATIBLE #endif - + #if !defined(__INCLUDE_FROM_TEMPERATURE_C) && !defined(TEMPERATURE_SENSOR_DRIVER_COMPATIBLE) #error The selected board does not contain a compatible temperature sensor. #endif @@ -140,7 +140,7 @@ #endif #endif - + #endif /** @} */ diff --git a/LUFA/Drivers/Misc/RingBuffer.h b/LUFA/Drivers/Misc/RingBuffer.h index 0ab3e33ab..bc6cfe885 100644 --- a/LUFA/Drivers/Misc/RingBuffer.h +++ b/LUFA/Drivers/Misc/RingBuffer.h @@ -44,11 +44,11 @@ * \defgroup Group_RingBuff Generic Byte Ring Buffer - LUFA/Drivers/Misc/RingBuffer.h * \brief Lightweight ring buffer, for fast insertion/deletion of bytes. * - * \section Sec_Dependencies Module Source Dependencies + * \section Sec_RingBuff_Dependencies Module Source Dependencies * The following files must be built with any user project that uses this module: * - None * - * \section Sec_ModDescription Module Description + * \section Sec_RingBuff_ModDescription Module Description * Lightweight ring buffer, for fast insertion/deletion. Multiple buffers can be created of * different sizes to suit different needs. * @@ -57,7 +57,7 @@ * or deletions) must not overlap. If there is possibility of two or more of the same kind of * operating occurring at the same point in time, atomic (mutex) locking should be used. * - * \section Sec_ExampleUsage Example Usage + * \section Sec_RingBuff_ExampleUsage Example Usage * The following snippet is an example of how this module may be used within a typical * application. * @@ -65,23 +65,23 @@ * // Create the buffer structure and its underlying storage array * RingBuffer_t Buffer; * uint8_t BufferData[128]; - * + * * // Initialize the buffer with the created storage array * RingBuffer_InitBuffer(&Buffer, BufferData, sizeof(BufferData)); - * + * * // Insert some data into the buffer * RingBuffer_Insert(Buffer, 'H'); * RingBuffer_Insert(Buffer, 'E'); * RingBuffer_Insert(Buffer, 'L'); * RingBuffer_Insert(Buffer, 'L'); * RingBuffer_Insert(Buffer, 'O'); - * + * * // Cache the number of stored bytes in the buffer * uint16_t BufferCount = RingBuffer_GetCount(&Buffer); - * + * * // Printer stored data length * printf("Buffer Length: %d, Buffer Data: \r\n", BufferCount); - * + * * // Print contents of the buffer one character at a time * while (BufferCount--) * putc(RingBuffer_Remove(&Buffer)); diff --git a/LUFA/Drivers/Misc/TerminalCodes.h b/LUFA/Drivers/Misc/TerminalCodes.h index 696c17d5e..55cd5e0ab 100644 --- a/LUFA/Drivers/Misc/TerminalCodes.h +++ b/LUFA/Drivers/Misc/TerminalCodes.h @@ -39,18 +39,18 @@ * \defgroup Group_Terminal ANSI Terminal Escape Codes - LUFA/Drivers/Misc/TerminalCodes.h * \brief ANSI terminal special escape code macros. * - * \section Sec_Dependencies Module Source Dependencies + * \section Sec_Terminal_Dependencies Module Source Dependencies * The following files must be built with any user project that uses this module: * - None * - * \section Sec_ModDescription Module Description + * \section Sec_Terminal_ModDescription Module Description * Escape code macros for ANSI compliant text terminals. * * \note If desired, the macro \c 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). * - * \section Sec_ExampleUsage Example Usage + * \section Sec_Terminal_ExampleUsage Example Usage * The following snippet is an example of how this module may be used within a typical * application. * diff --git a/LUFA/Drivers/Peripheral/ADC.h b/LUFA/Drivers/Peripheral/ADC.h index 033c1fbcf..4e40c0853 100644 --- a/LUFA/Drivers/Peripheral/ADC.h +++ b/LUFA/Drivers/Peripheral/ADC.h @@ -42,11 +42,11 @@ * \defgroup Group_ADC ADC Driver - LUFA/Drivers/Peripheral/ADC.h * \brief Hardware Analogue-to-Digital converter driver. * - * \section Sec_Dependencies Module Source Dependencies + * \section Sec_ADC_Dependencies Module Source Dependencies * The following files must be built with any user project that uses this module: * - None * - * \section Sec_ModDescription Module Description + * \section Sec_ADC_ModDescription Module Description * Hardware ADC driver. This module provides an easy to use driver for the hardware ADC * present on many microcontrollers, for the conversion of analogue signals into the * digital domain. diff --git a/LUFA/Drivers/Peripheral/AVR8/ADC_AVR8.h b/LUFA/Drivers/Peripheral/AVR8/ADC_AVR8.h index 02abbc7da..d4526e266 100644 --- a/LUFA/Drivers/Peripheral/AVR8/ADC_AVR8.h +++ b/LUFA/Drivers/Peripheral/AVR8/ADC_AVR8.h @@ -41,14 +41,14 @@ /** \ingroup Group_ADC * \defgroup Group_ADC_AVR8 ADC Peripheral Driver (AVR8) * - * \section Sec_ModDescription Module Description + * \section Sec_ADC_AVR8_ModDescription Module Description * On-chip Analogue-to-Digital converter (ADC) driver for supported U4, U6 and U7 model AVRs that contain an ADC * peripheral internally. * * \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. * - * \section Sec_ExampleUsage Example Usage + * \section Sec_ADC_AVR8_ExampleUsage Example Usage * The following snippet is an example of how this module may be used within a typical * application. * diff --git a/LUFA/Drivers/Peripheral/AVR8/SPI_AVR8.h b/LUFA/Drivers/Peripheral/AVR8/SPI_AVR8.h index 3fc681a28..b87b1c77d 100644 --- a/LUFA/Drivers/Peripheral/AVR8/SPI_AVR8.h +++ b/LUFA/Drivers/Peripheral/AVR8/SPI_AVR8.h @@ -40,7 +40,7 @@ /** \ingroup Group_SPI * \defgroup Group_SPI_AVR8 SPI Peripheral Driver (AVR8) * - * \section Sec_ModDescription Module Description + * \section Sec_SPI_AVR8_ModDescription Module Description * Driver for the hardware SPI port available on most 8-bit AVR microcontroller models. This * module provides an easy to use driver for the setup and transfer of data over the * AVR's SPI port. @@ -48,7 +48,7 @@ * \note This file should not be included directly. It is automatically included as needed by the SPI driver * dispatch header located in LUFA/Drivers/Peripheral/SPI.h. * - * \section Sec_ExampleUsage Example Usage + * \section Sec_SPI_AVR8_ExampleUsage Example Usage * The following snippet is an example of how this module may be used within a typical * application. * diff --git a/LUFA/Drivers/Peripheral/AVR8/SerialSPI_AVR8.h b/LUFA/Drivers/Peripheral/AVR8/SerialSPI_AVR8.h index ab1f2b5ac..f12aa77f7 100644 --- a/LUFA/Drivers/Peripheral/AVR8/SerialSPI_AVR8.h +++ b/LUFA/Drivers/Peripheral/AVR8/SerialSPI_AVR8.h @@ -40,30 +40,30 @@ /** \ingroup Group_SerialSPI * \defgroup Group_SerialSPI_AVR8 Master SPI Mode Serial USART Peripheral Driver (AVR8) * - * \section Sec_ModDescription Module Description + * \section Sec_SerialSPI_AVR8_ModDescription Module Description * On-chip serial USART driver for the 8-bit AVR8 microcontrollers. * * \note This file should not be included directly. It is automatically included as needed by the SPI Master * driver dispatch header located in LUFA/Drivers/Peripheral/SerialSPI.h. * - * \section Sec_ExampleUsage Example Usage + * \section Sec_SerialSPI_AVR8_ExampleUsage Example Usage * The following snippet is an example of how this module may be used within a typical * application. * * \code * // Initialize the Master SPI mode USART driver before first use, with 1Mbit baud * SerialSPI_Init((USART_SPI_SCK_LEAD_RISING | SPI_SAMPLE_LEADING | SPI_ORDER_MSB_FIRST), 1000000); - * + * * // Send several bytes, ignoring the returned data * SerialSPI_SendByte(0x01); * SerialSPI_SendByte(0x02); * SerialSPI_SendByte(0x03); - * + * * // Receive several bytes, sending a dummy 0x00 byte each time * uint8_t Byte1 = SerialSPI_ReceiveByte(); * uint8_t Byte2 = SerialSPI_ReceiveByte(); * uint8_t Byte3 = SerialSPI_ReceiveByte(); - * + * * // Send a byte, and store the received byte from the same transaction * uint8_t ResponseByte = SerialSPI_TransferByte(0xDC); * \endcode @@ -121,10 +121,10 @@ /** SPI data order mask for \ref SerialSPI_Init(). Indicates that data should be shifted out LSB first. */ #define USART_SPI_ORDER_LSB_FIRST (1 << UDORD) - //@} + //@} /* Inline Functions: */ - /** Initialize the USART module in Master SPI mode. + /** Initialize the USART module in Master SPI mode. * * \param[in] SPIOptions USART SPI Options, a mask consisting of one of each of the \c USART_SPI_SCK_*, * \c USART_SPI_SAMPLE_* and \c USART_SPI_ORDER_* masks. @@ -139,7 +139,7 @@ UCSR1B = ((1 << TXEN1) | (1 << RXEN1)); DDRD |= (1 << 3); - PORTD |= (1 << 2); + PORTD |= (1 << 2); } /** Turns off the USART driver, disabling and returning used hardware to their default configuration. */ @@ -154,7 +154,7 @@ DDRD &= ~(1 << 3); PORTD &= ~(1 << 2); } - + /** Sends and receives a byte through the USART SPI interface, blocking until the transfer is complete. * * \param[in] DataByte Byte to send through the USART SPI interface. @@ -188,7 +188,7 @@ { return SerialSPI_TransferByte(0); } - + /* Disable C linkage for C++ Compilers: */ #if defined(__cplusplus) } diff --git a/LUFA/Drivers/Peripheral/AVR8/Serial_AVR8.h b/LUFA/Drivers/Peripheral/AVR8/Serial_AVR8.h index c4864ab7e..724c19c73 100644 --- a/LUFA/Drivers/Peripheral/AVR8/Serial_AVR8.h +++ b/LUFA/Drivers/Peripheral/AVR8/Serial_AVR8.h @@ -40,13 +40,13 @@ /** \ingroup Group_Serial * \defgroup Group_Serial_AVR8 Serial USART Peripheral Driver (AVR8) * - * \section Sec_ModDescription Module Description + * \section Sec_Serial_AVR8_ModDescription Module Description * On-chip serial USART driver for the 8-bit AVR microcontrollers. * * \note This file should not be included directly. It is automatically included as needed by the USART driver * dispatch header located in LUFA/Drivers/Peripheral/Serial.h. * - * \section Sec_ExampleUsage Example Usage + * \section Sec_Serial_AVR8_ExampleUsage Example Usage * The following snippet is an example of how this module may be used within a typical * application. * diff --git a/LUFA/Drivers/Peripheral/AVR8/TWI_AVR8.h b/LUFA/Drivers/Peripheral/AVR8/TWI_AVR8.h index 80de7da80..498138f02 100644 --- a/LUFA/Drivers/Peripheral/AVR8/TWI_AVR8.h +++ b/LUFA/Drivers/Peripheral/AVR8/TWI_AVR8.h @@ -40,13 +40,13 @@ /** \ingroup Group_TWI * \defgroup Group_TWI_AVR8 TWI Peripheral Driver (AVR8) * - * \section Sec_ModDescription Module Description + * \section Sec_TWI_AVR8_ModDescription Module Description * Master mode TWI driver for the 8-bit AVR microcontrollers which contain a hardware TWI module. * * \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. * - * \section Sec_ExampleUsage Example Usage + * \section Sec_TWI_AVR8_ExampleUsage Example Usage * The following snippet is an example of how this module may be used within a typical * application. * diff --git a/LUFA/Drivers/Peripheral/SPI.h b/LUFA/Drivers/Peripheral/SPI.h index 3e0fd954e..16f91d992 100644 --- a/LUFA/Drivers/Peripheral/SPI.h +++ b/LUFA/Drivers/Peripheral/SPI.h @@ -42,11 +42,11 @@ * \defgroup Group_SPI SPI Driver - LUFA/Drivers/Peripheral/SPI.h * \brief Hardware Serial Peripheral Interface driver. * - * \section Sec_Dependencies Module Source Dependencies + * \section Sec_SPI_Dependencies Module Source Dependencies * The following files must be built with any user project that uses this module: * - None * - * \section Sec_ModDescription Module Description + * \section Sec_SPI_ModDescription Module Description * Hardware SPI driver. This module provides an easy to use driver for the setup and transfer of data over * the selected architecture and microcontroller model's SPI port. * diff --git a/LUFA/Drivers/Peripheral/Serial.h b/LUFA/Drivers/Peripheral/Serial.h index 5cb83d7a7..4dad0dc25 100644 --- a/LUFA/Drivers/Peripheral/Serial.h +++ b/LUFA/Drivers/Peripheral/Serial.h @@ -42,11 +42,11 @@ * \defgroup Group_Serial Serial USART Driver - LUFA/Drivers/Peripheral/Serial.h * \brief Hardware Serial USART driver. * - * \section Sec_Dependencies Module Source Dependencies + * \section Sec_Serial_Dependencies Module Source Dependencies * The following files must be built with any user project that uses this module: * - LUFA/Drivers/Peripheral/<i>ARCH</i>/Serial_<i>ARCH</i>.c <i>(Makefile source module name: LUFA_SRC_SERIAL)</i> * - * \section Sec_ModDescription Module Description + * \section Sec_Serial_ModDescription Module Description * Hardware serial USART driver. This module provides an easy to use driver for the setup and transfer * of data over the selected architecture and microcontroller model's USART port. * diff --git a/LUFA/Drivers/Peripheral/SerialSPI.h b/LUFA/Drivers/Peripheral/SerialSPI.h index 2c66cdcde..4efa5bd7a 100644 --- a/LUFA/Drivers/Peripheral/SerialSPI.h +++ b/LUFA/Drivers/Peripheral/SerialSPI.h @@ -42,11 +42,11 @@ * \defgroup Group_SerialSPI Master SPI Mode Serial USART Driver - LUFA/Drivers/Peripheral/SerialSPI.h * \brief Hardware SPI Master Mode Serial USART driver. * - * \section Sec_Dependencies Module Source Dependencies + * \section Sec_SerialSPI_Dependencies Module Source Dependencies * The following files must be built with any user project that uses this module: * - None * - * \section Sec_ModDescription Module Description + * \section Sec_SerialSPI_ModDescription Module Description * Hardware SPI Master Mode serial USART driver. This module provides an easy to use driver for the setup and transfer * of data over the selected architecture and microcontroller model's USART port, using a SPI framing format. * diff --git a/LUFA/Drivers/Peripheral/TWI.h b/LUFA/Drivers/Peripheral/TWI.h index e8e45769a..7782f619a 100644 --- a/LUFA/Drivers/Peripheral/TWI.h +++ b/LUFA/Drivers/Peripheral/TWI.h @@ -42,11 +42,11 @@ * \defgroup Group_TWI TWI Driver - LUFA/Drivers/Peripheral/TWI.h * \brief Hardware Two Wire Interface (I2C) driver. * - * \section Sec_Dependencies Module Source Dependencies + * \section Sec_TWI_Dependencies Module Source Dependencies * The following files must be built with any user project that uses this module: * - LUFA/Drivers/Peripheral/<i>ARCH</i>/TWI_<i>ARCH</i>.c <i>(Makefile source module name: LUFA_SRC_TWI)</i> * - * \section Sec_ModDescription Module Description + * \section Sec_TWI_ModDescription Module Description * Hardware TWI driver. This module provides an easy to use driver for the setup and transfer of data over * the selected architecture and microcontroller model's TWI bus port. * diff --git a/LUFA/Drivers/Peripheral/XMEGA/SPI_XMEGA.h b/LUFA/Drivers/Peripheral/XMEGA/SPI_XMEGA.h index b1678dbbe..07f6d4800 100644 --- a/LUFA/Drivers/Peripheral/XMEGA/SPI_XMEGA.h +++ b/LUFA/Drivers/Peripheral/XMEGA/SPI_XMEGA.h @@ -40,7 +40,7 @@ /** \ingroup Group_SPI * \defgroup Group_SPI_XMEGA SPI Peripheral Driver (XMEGA) * - * \section Sec_ModDescription Module Description + * \section Sec_SPI_XMEGA_ModDescription Module Description * Driver for the hardware SPI port(s) available on XMEGA AVR microcontroller models. This * module provides an easy to use driver for the setup and transfer of data over the AVR's * SPI ports. diff --git a/LUFA/Drivers/Peripheral/XMEGA/SerialSPI_XMEGA.h b/LUFA/Drivers/Peripheral/XMEGA/SerialSPI_XMEGA.h index 9248622d0..7f5226b05 100644 --- a/LUFA/Drivers/Peripheral/XMEGA/SerialSPI_XMEGA.h +++ b/LUFA/Drivers/Peripheral/XMEGA/SerialSPI_XMEGA.h @@ -40,13 +40,13 @@ /** \ingroup Group_SerialSPI * \defgroup Group_SerialSPI_XMEGA Master SPI Mode Serial USART Peripheral Driver (XMEGA) * - * \section Sec_ModDescription Module Description + * \section Sec_SerialSPI_XMEGA_ModDescription Module Description * On-chip serial USART driver for the XMEGA AVR microcontrollers. * * \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/SerialSPI.h. * - * \section Sec_ExampleUsage Example Usage + * \section Sec_SerialSPI_XMEGA_ExampleUsage Example Usage * The following snippet is an example of how this module may be used within a typical * application. * diff --git a/LUFA/Drivers/Peripheral/XMEGA/Serial_XMEGA.h b/LUFA/Drivers/Peripheral/XMEGA/Serial_XMEGA.h index b5af9c6e2..e337b311e 100644 --- a/LUFA/Drivers/Peripheral/XMEGA/Serial_XMEGA.h +++ b/LUFA/Drivers/Peripheral/XMEGA/Serial_XMEGA.h @@ -40,13 +40,13 @@ /** \ingroup Group_Serial * \defgroup Group_Serial_XMEGA Serial USART Peripheral Driver (XMEGA) * - * \section Sec_ModDescription Module Description + * \section Sec_Serial_XMEGA_ModDescription Module Description * On-chip serial USART driver for the XMEGA AVR microcontrollers. * * \note This file should not be included directly. It is automatically included as needed by the USART driver * dispatch header located in LUFA/Drivers/Peripheral/Serial.h. * - * \section Sec_ExampleUsage Example Usage + * \section Sec_Serial_XMEGA_ExampleUsage Example Usage * The following snippet is an example of how this module may be used within a typical * application. * diff --git a/LUFA/Drivers/USB/Class/AndroidAccessoryClass.h b/LUFA/Drivers/USB/Class/AndroidAccessoryClass.h index 90fa92427..19dff7a8e 100644 --- a/LUFA/Drivers/USB/Class/AndroidAccessoryClass.h +++ b/LUFA/Drivers/USB/Class/AndroidAccessoryClass.h @@ -41,11 +41,11 @@ * \defgroup Group_USBClassAOA Android Open Accessory Class Driver * \brief USB class driver for the Google Android Open Accessory class standard. * - * \section Sec_Dependencies Module Source Dependencies + * \section Sec_USBClassAOA_Dependencies Module Source Dependencies * The following files must be built with any user project that uses this module: * - LUFA/Drivers/USB/Class/Host/AndroidAccessoryClassHost.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i> * - * \section Sec_ModDescription Module Description + * \section Sec_USBClassAOA_ModDescription Module Description * Android Open Accessory Class Driver module. This module contains an internal implementation of the USB Android Open Accessory * Class, for Host USB mode. User applications can use this class driver instead of implementing the Android Open Accessory Class * manually via the low-level LUFA APIs. diff --git a/LUFA/Drivers/USB/Class/AudioClass.h b/LUFA/Drivers/USB/Class/AudioClass.h index 98fc7b61f..32d724777 100644 --- a/LUFA/Drivers/USB/Class/AudioClass.h +++ b/LUFA/Drivers/USB/Class/AudioClass.h @@ -41,12 +41,12 @@ * \defgroup Group_USBClassAudio Audio 1.0 Class Driver * \brief USB class driver for the USB-IF Audio 1.0 class standard. * - * \section Sec_Dependencies Module Source Dependencies + * \section Sec_USBClassAudio_Dependencies Module Source Dependencies * The following files must be built with any user project that uses this module: * - LUFA/Drivers/USB/Class/Device/AudioClassDevice.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i> * - LUFA/Drivers/USB/Class/Host/AudioClassHost.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i> * - * \section Sec_ModDescription Module Description + * \section Sec_USBClassAudio_ModDescription Module Description * Audio 1.0 Class Driver module. This module contains an internal implementation of the USB Audio 1.0 Class, for both * Device and Host USB modes. User applications can use this class driver instead of implementing the Audio 1.0 class * manually via the low-level LUFA APIs. diff --git a/LUFA/Drivers/USB/Class/CDCClass.h b/LUFA/Drivers/USB/Class/CDCClass.h index a15479994..d6336beb6 100644 --- a/LUFA/Drivers/USB/Class/CDCClass.h +++ b/LUFA/Drivers/USB/Class/CDCClass.h @@ -41,12 +41,12 @@ * \defgroup Group_USBClassCDC CDC-ACM (Virtual Serial) Class Driver * \brief USB class driver for the USB-IF CDC-ACM (Virtual Serial) class standard. * - * \section Sec_Dependencies Module Source Dependencies + * \section Sec_USBClassCDC_Dependencies Module Source Dependencies * The following files must be built with any user project that uses this module: * - LUFA/Drivers/USB/Class/Device/CDCClassDevice.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i> * - LUFA/Drivers/USB/Class/Host/CDCClassHost.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i> * - * \section Sec_ModDescription Module Description + * \section Sec_USBClassCDC_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/AndroidAccessoryClassCommon.h b/LUFA/Drivers/USB/Class/Common/AndroidAccessoryClassCommon.h index feb8e4b40..a7b2083d6 100644 --- a/LUFA/Drivers/USB/Class/Common/AndroidAccessoryClassCommon.h +++ b/LUFA/Drivers/USB/Class/Common/AndroidAccessoryClassCommon.h @@ -40,7 +40,7 @@ /** \ingroup Group_USBClassAOA * \defgroup Group_USBClassAOACommon Common Class Definitions * - * \section Sec_ModDescription Module Description + * \section Sec_USBClassAOACommon_ModDescription Module Description * Constants, Types and Enum definitions that are common to both Device and Host modes for the USB * Android Open Accessory Class. * diff --git a/LUFA/Drivers/USB/Class/Common/AudioClassCommon.h b/LUFA/Drivers/USB/Class/Common/AudioClassCommon.h index 0ce459788..6e4087305 100644 --- a/LUFA/Drivers/USB/Class/Common/AudioClassCommon.h +++ b/LUFA/Drivers/USB/Class/Common/AudioClassCommon.h @@ -40,7 +40,7 @@ /** \ingroup Group_USBClassAudio * \defgroup Group_USBClassAudioCommon Common Class Definitions * - * \section Sec_ModDescription Module Description + * \section Sec_USBClassAudioCommon_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/CDCClassCommon.h b/LUFA/Drivers/USB/Class/Common/CDCClassCommon.h index 9d419ac63..5f451b0d3 100644 --- a/LUFA/Drivers/USB/Class/Common/CDCClassCommon.h +++ b/LUFA/Drivers/USB/Class/Common/CDCClassCommon.h @@ -40,7 +40,7 @@ /** \ingroup Group_USBClassCDC * \defgroup Group_USBClassCDCCommon Common Class Definitions * - * \section Sec_ModDescription Module Description + * \section Sec_USBClassCDCCommon_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/HIDClassCommon.h b/LUFA/Drivers/USB/Class/Common/HIDClassCommon.h index f40afd3f9..534dec7e4 100644 --- a/LUFA/Drivers/USB/Class/Common/HIDClassCommon.h +++ b/LUFA/Drivers/USB/Class/Common/HIDClassCommon.h @@ -40,7 +40,7 @@ /** \ingroup Group_USBClassHID * \defgroup Group_USBClassHIDCommon Common Class Definitions * - * \section Sec_ModDescription Module Description + * \section Sec_USBClassHIDCommon_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/HIDParser.h b/LUFA/Drivers/USB/Class/Common/HIDParser.h index 66a30561e..f5454c3f3 100644 --- a/LUFA/Drivers/USB/Class/Common/HIDParser.h +++ b/LUFA/Drivers/USB/Class/Common/HIDParser.h @@ -40,11 +40,11 @@ * \defgroup Group_HIDParser HID Report Parser * \brief USB Human Interface Device (HID) Class report descriptor parser. * - * \section Sec_Dependencies Module Source Dependencies + * \section Sec_HIDParser_Dependencies Module Source Dependencies * The following files must be built with any user project that uses this module: * - LUFA/Drivers/USB/Class/Host/HIDParser.c <i>(Makefile source module name: LUFA_SRC_USB)</i> * - * \section Sec_ModDescription Module Description + * \section Sec_HIDParser_ModDescription Module Description * Human Interface Device (HID) class report descriptor parser. This module implements a parser than is * capable of processing a complete HID report descriptor, and outputting a flat structure containing the * contents of the report in an a more friendly format. The parsed data may then be further processed and used diff --git a/LUFA/Drivers/USB/Class/Common/MIDIClassCommon.h b/LUFA/Drivers/USB/Class/Common/MIDIClassCommon.h index 8c4897036..fbd633a4c 100644 --- a/LUFA/Drivers/USB/Class/Common/MIDIClassCommon.h +++ b/LUFA/Drivers/USB/Class/Common/MIDIClassCommon.h @@ -40,7 +40,7 @@ /** \ingroup Group_USBClassMIDI * \defgroup Group_USBClassMIDICommon Common Class Definitions * - * \section Sec_ModDescription Module Description + * \section Sec_USBClassMIDICommon_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/MassStorageClassCommon.h b/LUFA/Drivers/USB/Class/Common/MassStorageClassCommon.h index 10feb567a..097db508d 100644 --- a/LUFA/Drivers/USB/Class/Common/MassStorageClassCommon.h +++ b/LUFA/Drivers/USB/Class/Common/MassStorageClassCommon.h @@ -40,7 +40,7 @@ /** \ingroup Group_USBClassMS * \defgroup Group_USBClassMSCommon Common Class Definitions * - * \section Sec_ModDescription Module Description + * \section Sec_USBClassMSCommon_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/PrinterClassCommon.h b/LUFA/Drivers/USB/Class/Common/PrinterClassCommon.h index 09416c75e..12c04c891 100644 --- a/LUFA/Drivers/USB/Class/Common/PrinterClassCommon.h +++ b/LUFA/Drivers/USB/Class/Common/PrinterClassCommon.h @@ -40,7 +40,7 @@ /** \ingroup Group_USBClassPrinter * \defgroup Group_USBClassPrinterCommon Common Class Definitions * - * \section Sec_ModDescription Module Description + * \section Sec_USBClassPrinterCommon_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/RNDISClassCommon.h b/LUFA/Drivers/USB/Class/Common/RNDISClassCommon.h index 277b9e3e9..7b27dd01a 100644 --- a/LUFA/Drivers/USB/Class/Common/RNDISClassCommon.h +++ b/LUFA/Drivers/USB/Class/Common/RNDISClassCommon.h @@ -40,7 +40,7 @@ /** \ingroup Group_USBClassRNDIS * \defgroup Group_USBClassRNDISCommon Common Class Definitions * - * \section Sec_ModDescription Module Description + * \section Sec_USBClassRNDISCommon_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/StillImageClassCommon.h b/LUFA/Drivers/USB/Class/Common/StillImageClassCommon.h index c4f8a2f47..0c7db4667 100644 --- a/LUFA/Drivers/USB/Class/Common/StillImageClassCommon.h +++ b/LUFA/Drivers/USB/Class/Common/StillImageClassCommon.h @@ -40,7 +40,7 @@ /** \ingroup Group_USBClassSI * \defgroup Group_USBClassSICommon Common Class Definitions * - * \section Sec_ModDescription Module Description + * \section Sec_USBClassSICommon_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/AudioClassDevice.h b/LUFA/Drivers/USB/Class/Device/AudioClassDevice.h index fa1ca95f0..8c26ca209 100644 --- a/LUFA/Drivers/USB/Class/Device/AudioClassDevice.h +++ b/LUFA/Drivers/USB/Class/Device/AudioClassDevice.h @@ -40,11 +40,11 @@ /** \ingroup Group_USBClassAudio * \defgroup Group_USBClassAudioDevice Audio 1.0 Class Device Mode Driver * - * \section Sec_Dependencies Module Source Dependencies + * \section Sec_USBClassAudioDevice_Dependencies Module Source Dependencies * The following files must be built with any user project that uses this module: * - LUFA/Drivers/USB/Class/Device/AudioClassDevice.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i> * - * \section Sec_ModDescription Module Description + * \section Sec_USBClassAudioDevice_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/CDCClassDevice.h b/LUFA/Drivers/USB/Class/Device/CDCClassDevice.h index b87fef1fd..2c662891e 100644 --- a/LUFA/Drivers/USB/Class/Device/CDCClassDevice.h +++ b/LUFA/Drivers/USB/Class/Device/CDCClassDevice.h @@ -40,11 +40,11 @@ /** \ingroup Group_USBClassCDC * \defgroup Group_USBClassCDCDevice CDC Class Device Mode Driver * - * \section Sec_Dependencies Module Source Dependencies + * \section Sec_USBClassCDCDevice_Dependencies Module Source Dependencies * The following files must be built with any user project that uses this module: * - LUFA/Drivers/USB/Class/Device/CDCClassDevice.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i> * - * \section Sec_ModDescription Module Description + * \section Sec_USBClassCDCDevice_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/HIDClassDevice.h b/LUFA/Drivers/USB/Class/Device/HIDClassDevice.h index 52700c93d..2915c9157 100644 --- a/LUFA/Drivers/USB/Class/Device/HIDClassDevice.h +++ b/LUFA/Drivers/USB/Class/Device/HIDClassDevice.h @@ -40,11 +40,11 @@ /** \ingroup Group_USBClassHID * \defgroup Group_USBClassHIDDevice HID Class Device Mode Driver * - * \section Sec_Dependencies Module Source Dependencies + * \section Sec_USBClassHIDDevice_Dependencies Module Source Dependencies * The following files must be built with any user project that uses this module: * - LUFA/Drivers/USB/Class/Device/HIDClassDevice.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i> * - * \section Sec_ModDescription Module Description + * \section Sec_USBClassHIDDevice_ModDescription Module Description * Device Mode USB Class driver framework interface, for the HID USB Class driver. * * @{ diff --git a/LUFA/Drivers/USB/Class/Device/MIDIClassDevice.h b/LUFA/Drivers/USB/Class/Device/MIDIClassDevice.h index 443f8ac87..4b8be3ebc 100644 --- a/LUFA/Drivers/USB/Class/Device/MIDIClassDevice.h +++ b/LUFA/Drivers/USB/Class/Device/MIDIClassDevice.h @@ -40,11 +40,11 @@ /** \ingroup Group_USBClassMIDI * \defgroup Group_USBClassMIDIDevice MIDI Class Device Mode Driver * - * \section Sec_Dependencies Module Source Dependencies + * \section Sec_USBClassMIDIDevice_Dependencies Module Source Dependencies * The following files must be built with any user project that uses this module: * - LUFA/Drivers/USB/Class/Device/MIDIClassDevice.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i> * - * \section Sec_ModDescription Module Description + * \section Sec_USBClassMIDIDevice_ModDescription Module Description * Device Mode USB Class driver framework interface, for the MIDI USB Class driver. * * @{ diff --git a/LUFA/Drivers/USB/Class/Device/MassStorageClassDevice.h b/LUFA/Drivers/USB/Class/Device/MassStorageClassDevice.h index a5c9b016a..3c3076c1a 100644 --- a/LUFA/Drivers/USB/Class/Device/MassStorageClassDevice.h +++ b/LUFA/Drivers/USB/Class/Device/MassStorageClassDevice.h @@ -40,11 +40,11 @@ /** \ingroup Group_USBClassMS * \defgroup Group_USBClassMSDevice Mass Storage Class Device Mode Driver * - * \section Sec_Dependencies Module Source Dependencies + * \section Sec_USBClassMSDevice_Dependencies Module Source Dependencies * The following files must be built with any user project that uses this module: * - LUFA/Drivers/USB/Class/Device/MassStorageClassDevice.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i> * - * \section Sec_ModDescription Module Description + * \section Sec_USBClassMSDevice_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/PrinterClassDevice.h b/LUFA/Drivers/USB/Class/Device/PrinterClassDevice.h index 1c50a9803..6cdc0dae6 100644 --- a/LUFA/Drivers/USB/Class/Device/PrinterClassDevice.h +++ b/LUFA/Drivers/USB/Class/Device/PrinterClassDevice.h @@ -40,11 +40,11 @@ /** \ingroup Group_USBClassPrinter * \defgroup Group_USBClassPrinterDevice Printer Class Device Mode Driver * - * \section Sec_Dependencies Module Source Dependencies + * \section Sec_USBClassPrinterDevice_Dependencies Module Source Dependencies * The following files must be built with any user project that uses this module: * - LUFA/Drivers/USB/Class/Device/PrinterClassDevice.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i> * - * \section Sec_ModDescription Module Description + * \section Sec_USBClassPrinterDevice_ModDescription Module Description * Device Mode USB Class driver framework interface, for the Printer USB Class driver. * * @{ diff --git a/LUFA/Drivers/USB/Class/Device/RNDISClassDevice.h b/LUFA/Drivers/USB/Class/Device/RNDISClassDevice.h index d455cc98b..3fc0e66ac 100644 --- a/LUFA/Drivers/USB/Class/Device/RNDISClassDevice.h +++ b/LUFA/Drivers/USB/Class/Device/RNDISClassDevice.h @@ -40,11 +40,11 @@ /** \ingroup Group_USBClassRNDIS * \defgroup Group_USBClassRNDISDevice RNDIS Class Device Mode Driver * - * \section Sec_Dependencies Module Source Dependencies + * \section Sec_USBClassRNDISDevice_Dependencies Module Source Dependencies * The following files must be built with any user project that uses this module: * - LUFA/Drivers/USB/Class/Device/RNDISClassDevice.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i> * - * \section Sec_ModDescription Module Description + * \section Sec_USBClassRNDISDevice_ModDescription Module Description * Device Mode USB Class driver framework interface, for the RNDIS USB Class driver. * * @{ diff --git a/LUFA/Drivers/USB/Class/HIDClass.h b/LUFA/Drivers/USB/Class/HIDClass.h index 7e73fbdda..48427e529 100644 --- a/LUFA/Drivers/USB/Class/HIDClass.h +++ b/LUFA/Drivers/USB/Class/HIDClass.h @@ -41,13 +41,13 @@ * \defgroup Group_USBClassHID HID Class Driver * \brief USB class driver for the USB-IF Human Interface Device (HID) class standard. * - * \section Sec_Dependencies Module Source Dependencies + * \section Sec_USBClassHID_Dependencies Module Source Dependencies * The following files must be built with any user project that uses this module: * - LUFA/Drivers/USB/Class/Device/HIDClassDevice.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i> * - LUFA/Drivers/USB/Class/Host/HIDClassHost.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i> * - LUFA/Drivers/USB/Class/Host/HIDParser.c <i>(Makefile source module name: LUFA_SRC_USB)</i> * - * \section Sec_ModDescription Module Description + * \section Sec_USBClassHID_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/AndroidAccessoryClassHost.h b/LUFA/Drivers/USB/Class/Host/AndroidAccessoryClassHost.h index bcc76f923..a8d3e90ba 100644 --- a/LUFA/Drivers/USB/Class/Host/AndroidAccessoryClassHost.h +++ b/LUFA/Drivers/USB/Class/Host/AndroidAccessoryClassHost.h @@ -40,11 +40,11 @@ /** \ingroup Group_USBClassAOA * \defgroup Group_USBClassAndroidAccessoryHost Android Open Accessory Class Host Mode Driver * - * \section Sec_Dependencies Module Source Dependencies + * \section Sec_USBClassAndroidAccessoryHost_Dependencies Module Source Dependencies * The following files must be built with any user project that uses this module: * - LUFA/Drivers/USB/Class/Host/AndroidAccessoryClassHost.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i> * - * \section Sec_ModDescription Module Description + * \section Sec_USBClassAndroidAccessoryHost_ModDescription Module Description * Host Mode USB Class driver framework interface, for the Android Open Accessory USB Class driver. * * @{ diff --git a/LUFA/Drivers/USB/Class/Host/AudioClassHost.h b/LUFA/Drivers/USB/Class/Host/AudioClassHost.h index a501868b9..02a79aae2 100644 --- a/LUFA/Drivers/USB/Class/Host/AudioClassHost.h +++ b/LUFA/Drivers/USB/Class/Host/AudioClassHost.h @@ -40,11 +40,11 @@ /** \ingroup Group_USBClassAudio * \defgroup Group_USBClassAudioHost Audio 1.0 Class Host Mode Driver * - * \section Sec_Dependencies Module Source Dependencies + * \section Sec_USBClassAudioHost_Dependencies Module Source Dependencies * The following files must be built with any user project that uses this module: * - LUFA/Drivers/USB/Class/Host/AudioClassHost.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i> * - * \section Sec_ModDescription Module Description + * \section Sec_USBClassAudioHost_ModDescription Module Description * Host Mode USB Class driver framework interface, for the Audio 1.0 USB Class driver. * * @{ diff --git a/LUFA/Drivers/USB/Class/Host/CDCClassHost.h b/LUFA/Drivers/USB/Class/Host/CDCClassHost.h index 9521c3c3f..2d8d70099 100644 --- a/LUFA/Drivers/USB/Class/Host/CDCClassHost.h +++ b/LUFA/Drivers/USB/Class/Host/CDCClassHost.h @@ -40,11 +40,11 @@ /** \ingroup Group_USBClassCDC * \defgroup Group_USBClassCDCHost CDC Class Host Mode Driver * - * \section Sec_Dependencies Module Source Dependencies + * \section Sec_USBClassCDCHost_Dependencies Module Source Dependencies * The following files must be built with any user project that uses this module: * - LUFA/Drivers/USB/Class/Host/CDCClassHost.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i> * - * \section Sec_ModDescription Module Description + * \section Sec_USBClassCDCHost_ModDescription Module Description * Host Mode USB Class driver framework interface, for the CDC USB Class driver. * * @{ diff --git a/LUFA/Drivers/USB/Class/Host/HIDClassHost.h b/LUFA/Drivers/USB/Class/Host/HIDClassHost.h index 72d32e5bc..965ac368f 100644 --- a/LUFA/Drivers/USB/Class/Host/HIDClassHost.h +++ b/LUFA/Drivers/USB/Class/Host/HIDClassHost.h @@ -40,11 +40,11 @@ /** \ingroup Group_USBClassHID * \defgroup Group_USBClassHIDHost HID Class Host Mode Driver * - * \section Sec_Dependencies Module Source Dependencies + * \section Sec_USBClassHIDHost_Dependencies Module Source Dependencies * The following files must be built with any user project that uses this module: * - LUFA/Drivers/USB/Class/Host/HIDClassHost.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i> * - * \section Sec_ModDescription Module Description + * \section Sec_USBClassHIDHost_ModDescription Module Description * Host Mode USB Class driver framework interface, for the HID USB Class driver. * * @{ diff --git a/LUFA/Drivers/USB/Class/Host/MIDIClassHost.h b/LUFA/Drivers/USB/Class/Host/MIDIClassHost.h index d367f4c1e..50832b8ae 100644 --- a/LUFA/Drivers/USB/Class/Host/MIDIClassHost.h +++ b/LUFA/Drivers/USB/Class/Host/MIDIClassHost.h @@ -40,11 +40,11 @@ /** \ingroup Group_USBClassMIDI * \defgroup Group_USBClassMIDIHost MIDI Class Host Mode Driver * - * \section Sec_Dependencies Module Source Dependencies + * \section Sec_USBClassMIDIHost_Dependencies Module Source Dependencies * The following files must be built with any user project that uses this module: * - LUFA/Drivers/USB/Class/Host/MIDIClassHost.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i> * - * \section Sec_ModDescription Module Description + * \section Sec_USBClassMIDIHost_ModDescription Module Description * Host Mode USB Class driver framework interface, for the MIDI USB Class driver. * * @{ diff --git a/LUFA/Drivers/USB/Class/Host/MassStorageClassHost.h b/LUFA/Drivers/USB/Class/Host/MassStorageClassHost.h index 8de3e72f5..37cfd0fe5 100644 --- a/LUFA/Drivers/USB/Class/Host/MassStorageClassHost.h +++ b/LUFA/Drivers/USB/Class/Host/MassStorageClassHost.h @@ -40,11 +40,11 @@ /** \ingroup Group_USBClassMS * \defgroup Group_USBClassMassStorageHost Mass Storage Class Host Mode Driver * - * \section Sec_Dependencies Module Source Dependencies + * \section Sec_USBClassMassStorageHost_Dependencies Module Source Dependencies * The following files must be built with any user project that uses this module: * - LUFA/Drivers/USB/Class/Host/MassStorageClassHost.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i> * - * \section Sec_ModDescription Module Description + * \section Sec_USBClassMassStorageHost_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/PrinterClassHost.h b/LUFA/Drivers/USB/Class/Host/PrinterClassHost.h index 792f86564..1952b9cf0 100644 --- a/LUFA/Drivers/USB/Class/Host/PrinterClassHost.h +++ b/LUFA/Drivers/USB/Class/Host/PrinterClassHost.h @@ -40,11 +40,11 @@ /** \ingroup Group_USBClassPrinter * \defgroup Group_USBClassPrinterHost Printer Class Host Mode Driver * - * \section Sec_Dependencies Module Source Dependencies + * \section Sec_USBClassPrinterHost_Dependencies Module Source Dependencies * The following files must be built with any user project that uses this module: * - LUFA/Drivers/USB/Class/Host/PrinterClassHost.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i> * - * \section Sec_ModDescription Module Description + * \section Sec_USBClassPrinterHost_ModDescription Module Description * Host Mode USB Class driver framework interface, for the Printer USB Class driver. * * @{ diff --git a/LUFA/Drivers/USB/Class/Host/RNDISClassHost.h b/LUFA/Drivers/USB/Class/Host/RNDISClassHost.h index 001860c38..497469e5d 100644 --- a/LUFA/Drivers/USB/Class/Host/RNDISClassHost.h +++ b/LUFA/Drivers/USB/Class/Host/RNDISClassHost.h @@ -40,11 +40,11 @@ /** \ingroup Group_USBClassRNDIS * \defgroup Group_USBClassRNDISHost RNDIS Class Host Mode Driver * - * \section Sec_Dependencies Module Source Dependencies + * \section Sec_USBClassRNDISHost_Dependencies Module Source Dependencies * The following files must be built with any user project that uses this module: * - LUFA/Drivers/USB/Class/Host/RNDISClassHost.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i> * - * \section Sec_ModDescription Module Description + * \section Sec_USBClassRNDISHost_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/StillImageClassHost.h b/LUFA/Drivers/USB/Class/Host/StillImageClassHost.h index 6e68e1305..daf25e8a1 100644 --- a/LUFA/Drivers/USB/Class/Host/StillImageClassHost.h +++ b/LUFA/Drivers/USB/Class/Host/StillImageClassHost.h @@ -40,11 +40,11 @@ /** \ingroup Group_USBClassSI * \defgroup Group_USBClassStillImageHost Still Image Class Host Mode Driver * - * \section Sec_Dependencies Module Source Dependencies + * \section Sec_USBClassStillImageHost_Dependencies Module Source Dependencies * The following files must be built with any user project that uses this module: * - LUFA/Drivers/USB/Class/Host/StillImageClassHost.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i> * - * \section Sec_ModDescription Module Description + * \section Sec_USBClassStillImageHost_ModDescription Module Description * Host Mode USB Class driver framework interface, for the Still Image USB Class driver. * * @{ diff --git a/LUFA/Drivers/USB/Class/MIDIClass.h b/LUFA/Drivers/USB/Class/MIDIClass.h index d8d986631..9583085e7 100644 --- a/LUFA/Drivers/USB/Class/MIDIClass.h +++ b/LUFA/Drivers/USB/Class/MIDIClass.h @@ -41,12 +41,12 @@ * \defgroup Group_USBClassMIDI MIDI Class Driver * \brief USB class driver for the USB-IF MIDI class standard. * - * \section Sec_Dependencies Module Source Dependencies + * \section Sec_USBClassMIDI_Dependencies Module Source Dependencies * The following files must be built with any user project that uses this module: * - LUFA/Drivers/USB/Class/Device/MIDIClassDevice.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i> * - LUFA/Drivers/USB/Class/Host/MIDIClassHost.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i> * - * \section Sec_ModDescription Module Description + * \section Sec_USBClassMIDI_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/MassStorageClass.h b/LUFA/Drivers/USB/Class/MassStorageClass.h index ddb027f31..c9285b662 100644 --- a/LUFA/Drivers/USB/Class/MassStorageClass.h +++ b/LUFA/Drivers/USB/Class/MassStorageClass.h @@ -41,12 +41,12 @@ * \defgroup Group_USBClassMS Mass Storage Class Driver * \brief USB class driver for the USB-IF Bulk-Only Transport Mass Storage class standard. * - * \section Sec_Dependencies Module Source Dependencies + * \section Sec_USBClassMS_Dependencies Module Source Dependencies * The following files must be built with any user project that uses this module: * - LUFA/Drivers/USB/Class/Device/MassStorageClassDevice.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i> * - LUFA/Drivers/USB/Class/Host/MassStorageClassHost.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i> * - * \section Sec_ModDescription Module Description + * \section Sec_USBClassMS_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/PrinterClass.h b/LUFA/Drivers/USB/Class/PrinterClass.h index be072275d..0f38ad257 100644 --- a/LUFA/Drivers/USB/Class/PrinterClass.h +++ b/LUFA/Drivers/USB/Class/PrinterClass.h @@ -41,12 +41,12 @@ * \defgroup Group_USBClassPrinter Printer Class Driver * \brief USB class driver for the USB-IF Printer class standard. * - * \section Sec_Dependencies Module Source Dependencies + * \section Sec_USBClassPrinter_Dependencies Module Source Dependencies * The following files must be built with any user project that uses this module: * - LUFA/Drivers/USB/Class/Host/PrinterClassDevice.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i> * - LUFA/Drivers/USB/Class/Host/PrinterClassHost.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i> * - * \section Sec_ModDescription Module Description + * \section Sec_USBClassPrinter_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/RNDISClass.h b/LUFA/Drivers/USB/Class/RNDISClass.h index dde8396c4..926472b9c 100644 --- a/LUFA/Drivers/USB/Class/RNDISClass.h +++ b/LUFA/Drivers/USB/Class/RNDISClass.h @@ -41,12 +41,12 @@ * \defgroup Group_USBClassRNDIS RNDIS (Networking) Class Driver * \brief USB class driver for the Microsoft Remote Network Driver Interface Specification (RNDIS) class standard. * - * \section Sec_Dependencies Module Source Dependencies + * \section Sec_USBClassRNDIS_Dependencies Module Source Dependencies * The following files must be built with any user project that uses this module: * - LUFA/Drivers/USB/Class/Device/RNDISClassDevice.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i> * - LUFA/Drivers/USB/Class/Host/RNDISClassHost.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i> * - * \section Sec_ModDescription Module Description + * \section Sec_USBClassRNDIS_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/StillImageClass.h b/LUFA/Drivers/USB/Class/StillImageClass.h index 331bc7222..7fd8eeb8f 100644 --- a/LUFA/Drivers/USB/Class/StillImageClass.h +++ b/LUFA/Drivers/USB/Class/StillImageClass.h @@ -41,11 +41,11 @@ * \defgroup Group_USBClassSI Still Image Class Driver * \brief USB class driver for the USB-IF Still Image (PIMA-compliant) class standard. * - * \section Sec_Dependencies Module Source Dependencies + * \section Sec_USBClassSI_Dependencies Module Source Dependencies * The following files must be built with any user project that uses this module: * - LUFA/Drivers/USB/Class/Host/StillImageClassHost.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i> * - * \section Sec_ModDescription Module Description + * \section Sec_USBClassSI_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 1f38c0650..689959116 100644 --- a/LUFA/Drivers/USB/USB.h +++ b/LUFA/Drivers/USB/USB.h @@ -41,7 +41,7 @@ * * \brief Core driver for the microcontroller hardware USB module * - * \section Sec_Dependencies Module Source Dependencies + * \section Sec_USB_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> * - LUFA/Drivers/USB/Core/DeviceStandardReq.c <i>(Makefile source module name: LUFA_SRC_USB)</i> @@ -58,7 +58,7 @@ * - LUFA/Drivers/USB/Core/<i>ARCH</i>/USBInterrupt_<i>ARCH</i>.c <i>(Makefile source module name: LUFA_SRC_USB)</i> * - LUFA/Drivers/USB/Class/Common/HIDParser.c <i>(Makefile source module name: LUFA_SRC_USB)</i> * - * \section Sec_ModDescription Module Description + * \section Sec_USB_ModDescription Module Description * Driver and framework for the USB controller of the selected architecture and microcontroller model. 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. @@ -143,13 +143,13 @@ * </table> * * - * \section Sec_UsingClassDrivers Using the Class Drivers + * \section Sec_USB_UsingClassDrivers Using the Class Drivers * To make the Class drivers easy to integrate into a user application, they all implement a standardized * design with similarly named/used function, enums, defines and types. The two different modes are implemented * slightly differently, and thus will be explained separately. For information on a specific class driver, read * the class driver's module documentation. * - * \subsection Sec_ClassDriverDevice Device Mode Class Drivers + * \subsection Sec_USB_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 <tt>USB_ClassInfo_<i>{Class Name}</i>_Device_t</tt>, and are used to hold the @@ -249,7 +249,7 @@ * read and write routines. See each driver's individual documentation for more information on the * class-specific functions. * - * \subsection Sec_ClassDriverHost Host Mode Class Drivers + * \subsection Sec_USB_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 <tt>USB_ClassInfo_<b>{Class Name}</b>_Host_t</tt>, and are used to hold the diff --git a/LUFA/Platform/Platform.h b/LUFA/Platform/Platform.h index a83e42d34..0eb83cb6b 100644 --- a/LUFA/Platform/Platform.h +++ b/LUFA/Platform/Platform.h @@ -44,12 +44,12 @@ /** \defgroup Group_PlatformDrivers System Platform Drivers - LUFA/Platform/Platform.h * \brief Hardware platform drivers. * - * \section Sec_Dependencies Module Source Dependencies + * \section Sec_PlatformDrivers_Dependencies Module Source Dependencies * The following files must be built with any user project that uses this module: - * - <b>UC3 Architecture Only:</b> LUFA/Platform/UC3/InterruptManagement.c <i>(Makefile source module name: LUFA_SRC_PLATFORM)</i> + * - <b>UC3 Architecture Only:</b> LUFA/Platform/UC3/InterruptManagement.c <i>(Makefile source module name: LUFA_SRC_PLATFORM)</i> * - <b>UC3 Architecture Only:</b> LUFA/Platform/UC3/Exception.S <i>(Makefile source module name: LUFA_SRC_PLATFORM)</i> * - * \section Sec_ModDescription Module Description + * \section Sec_PlatformDrivers_ModDescription Module Description * Device-specific hardware platform drivers, for low level hardware configuration and management. The platform * drivers are a set of drivers which are designed to provide a high level management layer for the various low level * system functions such as clock control and interrupt management. diff --git a/LUFA/Platform/UC3/ClockManagement.h b/LUFA/Platform/UC3/ClockManagement.h index de2c1f9f7..2b1ed5612 100644 --- a/LUFA/Platform/UC3/ClockManagement.h +++ b/LUFA/Platform/UC3/ClockManagement.h @@ -39,27 +39,27 @@ * \defgroup Group_PlatformDrivers_UC3Clocks Clock Management Driver - LUFA/Platform/UC3/ClockManagement.h * \brief Module Clock Driver for the AVR32 UC3 microcontrollers. * - * \section Sec_Dependencies Module Source Dependencies + * \section Sec_PlatformDrivers_UC3Clocks_Dependencies Module Source Dependencies * The following files must be built with any user project that uses this module: * - None * - * \section Sec_ModDescription Module Description + * \section Sec_PlatformDrivers_UC3Clocks_ModDescription Module Description * Clock management driver for the AVR32 UC3 microcontrollers. This driver allows for the configuration * of the various clocks within the device to clock the various peripherals. * * Usage Example: * \code * #include <LUFA/Platform/UC3/ClockManagement.h> - * + * * void main(void) * { * // Start the master external oscillator which will be used as the main clock reference * UC3CLK_StartExternalOscillator(0, EXOSC_MODE_8MHZ_OR_MORE, EXOSC_START_0CLK); - * + * * // Start the PLL for the CPU clock, switch CPU to it * UC3CLK_StartPLL(0, CLOCK_SRC_OSC0, 12000000, F_CPU); * UC3CLK_SetCPUClockSource(CLOCK_SRC_PLL0, F_CPU); - * + * * // Start the PLL for the USB Generic Clock module * UC3CLK_StartPLL(1, CLOCK_SRC_OSC0, 12000000, 48000000); * } @@ -277,9 +277,9 @@ { if (Channel >= AVR32_PM_GCLK_NUM) return false; - + AVR32_PM.GCCTRL[Channel].cen = false; - + return true; } @@ -302,7 +302,7 @@ return false; AVR32_FLASHC.FCR.fws = (SourceFreq > AVR32_FLASHC_FWS_0_MAX_FREQ) ? true : false; - + switch (Source) { #if defined(AVR32_PM_MCCTRL_MCSEL_SLOW) diff --git a/LUFA/Platform/UC3/InterruptManagement.h b/LUFA/Platform/UC3/InterruptManagement.h index 757bcc601..e1f64fcad 100644 --- a/LUFA/Platform/UC3/InterruptManagement.h +++ b/LUFA/Platform/UC3/InterruptManagement.h @@ -39,24 +39,24 @@ * \defgroup Group_PlatformDrivers_UC3Interrupts Interrupt Controller Driver - LUFA/Platform/UC3/InterruptManagement.h * \brief Interrupt Controller Driver for the AVR32 UC3 microcontrollers. * - * \section Sec_Dependencies Module Source Dependencies + * \section Sec_PlatformDrivers_UC3Interrupts_Dependencies Module Source Dependencies * The following files must be built with any user project that uses this module: * - LUFA/Platform/UC3/InterruptManagement.c <i>(Makefile source module name: LUFA_SRC_PLATFORM)</i> * - LUFA/Platform/UC3/Exception.S <i>(Makefile source module name: LUFA_SRC_PLATFORM)</i> * - * \section Sec_ModDescription Module Description + * \section Sec_PlatformDrivers_UC3Interrupts_ModDescription Module Description * Interrupt controller driver for the AVR32 UC3 microcontrollers, for the configuration of interrupt * handlers within the device. * * Usage Example: * \code * #include <LUFA/Platform/UC3/InterruptManagement.h> - * + * * ISR(USB_Group_IRQ_Handler) * { * // USB group handler code here * } - * + * * void main(void) * { * INTC_Init(); @@ -113,8 +113,8 @@ /** Initializes the interrupt controller ready to handle interrupts. This must be called at the * start of the user program before any interrupts are registered or enabled. */ - void INTC_Init(void); - + void INTC_Init(void); + /** Retrieves the associated interrupt handler for the interrupt group currently being fired. This * is called directly from the exception handler routine before dispatching to the ISR. * diff --git a/LUFA/Platform/XMEGA/ClockManagement.h b/LUFA/Platform/XMEGA/ClockManagement.h index ec341a2c8..fdcc52ef5 100644 --- a/LUFA/Platform/XMEGA/ClockManagement.h +++ b/LUFA/Platform/XMEGA/ClockManagement.h @@ -39,11 +39,11 @@ * \defgroup Group_PlatformDrivers_XMEGAClocks Clock Management Driver - LUFA/Platform/XMEGA/ClockManagement.h * \brief Module Clock Driver for the AVR USB XMEGA microcontrollers. * - * \section Sec_Dependencies Module Source Dependencies + * \section Sec_PlatformDrivers_XMEGAClocks_Dependencies Module Source Dependencies * The following files must be built with any user project that uses this module: * - None * - * \section Sec_ModDescription Module Description + * \section Sec_PlatformDrivers_XMEGAClocks_ModDescription Module Description * Clock management driver for the AVR USB XMEGA microcontrollers. This driver allows for the configuration * of the various clocks within the device to clock the various peripherals. * |