aboutsummaryrefslogtreecommitdiffstats
path: root/LUFA/DoxygenPages
diff options
context:
space:
mode:
authorDean Camera <dean@fourwalledcubicle.com>2013-06-01 21:55:31 +0200
committerDean Camera <dean@fourwalledcubicle.com>2013-06-01 21:55:31 +0200
commit7941245122dc547952e573b2c5e8fd7bc657f257 (patch)
tree80ce02a74b7714d26089f750c6223c102abc9158 /LUFA/DoxygenPages
parent16037433a2caf0c93b811b774a9ea5fd1324514e (diff)
downloadlufa-7941245122dc547952e573b2c5e8fd7bc657f257.tar.gz
lufa-7941245122dc547952e573b2c5e8fd7bc657f257.tar.bz2
lufa-7941245122dc547952e573b2c5e8fd7bc657f257.zip
Ensure core library documentation sections use unique IDs.
Diffstat (limited to 'LUFA/DoxygenPages')
-rw-r--r--LUFA/DoxygenPages/BuildSystem.txt8
-rw-r--r--LUFA/DoxygenPages/CompileTimeTokens.txt10
-rw-r--r--LUFA/DoxygenPages/CompilingApps.txt8
-rw-r--r--LUFA/DoxygenPages/ConfiguringApps.txt24
4 files changed, 25 insertions, 25 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.
*/