From 7941245122dc547952e573b2c5e8fd7bc657f257 Mon Sep 17 00:00:00 2001 From: Dean Camera Date: Sat, 1 Jun 2013 21:55:31 +0200 Subject: Ensure core library documentation sections use unique IDs. --- LUFA/Platform/Platform.h | 6 +++--- LUFA/Platform/UC3/ClockManagement.h | 16 ++++++++-------- LUFA/Platform/UC3/InterruptManagement.h | 12 ++++++------ LUFA/Platform/XMEGA/ClockManagement.h | 4 ++-- 4 files changed, 19 insertions(+), 19 deletions(-) (limited to 'LUFA/Platform') 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: - * - UC3 Architecture Only: LUFA/Platform/UC3/InterruptManagement.c (Makefile source module name: LUFA_SRC_PLATFORM) + * - UC3 Architecture Only: LUFA/Platform/UC3/InterruptManagement.c (Makefile source module name: LUFA_SRC_PLATFORM) * - UC3 Architecture Only: LUFA/Platform/UC3/Exception.S (Makefile source module name: LUFA_SRC_PLATFORM) * - * \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 - * + * * 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 (Makefile source module name: LUFA_SRC_PLATFORM) * - LUFA/Platform/UC3/Exception.S (Makefile source module name: LUFA_SRC_PLATFORM) * - * \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 - * + * * 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. * -- cgit v1.2.3