From 4cd80263ff477e81ab88dc76f32103f3852a0468 Mon Sep 17 00:00:00 2001 From: Dean Camera Date: Sun, 23 Sep 2012 11:09:09 +0000 Subject: Minor documentation improvements. Remove AS4 project generator script as it is buggy; replace with a better system in the future for both AS4 and AS6. --- LUFA/DoxygenPages/BuildSystem.txt | 2 +- LUFA/DoxygenPages/CompilingApps.txt | 12 +- LUFA/DoxygenPages/ConfiguringApps.txt | 2 +- LUFA/DoxygenPages/VIDAndPIDValues.txt | 419 ++++++++-------------------------- 4 files changed, 105 insertions(+), 330 deletions(-) (limited to 'LUFA') diff --git a/LUFA/DoxygenPages/BuildSystem.txt b/LUFA/DoxygenPages/BuildSystem.txt index 57dec5424..57a01d944 100644 --- a/LUFA/DoxygenPages/BuildSystem.txt +++ b/LUFA/DoxygenPages/BuildSystem.txt @@ -25,7 +25,7 @@ * project's build makefile targets automatically. To call a build target, run make {TARGET_NAME} * from the command line, substituting in the appropriate target name. * - * \see \ref Sec_AppConfigParams for a copy of the sample LUFA project makefile. + * \see \ref Sec_AppMakefileParams for a copy of the sample LUFA project makefile. * * Each build module may have one or more mandatory parameters (GNU Make variables) which must * be supplied in the project makefile for the module to work, and one or more optional parameters which diff --git a/LUFA/DoxygenPages/CompilingApps.txt b/LUFA/DoxygenPages/CompilingApps.txt index 40e03a7aa..71a7dc3f2 100644 --- a/LUFA/DoxygenPages/CompilingApps.txt +++ b/LUFA/DoxygenPages/CompilingApps.txt @@ -14,23 +14,23 @@ * compilation of LUFA based applications. * * \subsection SSec_PreqWindows Windows Prerequisites - * On Windows, you will need a copy of the latest Atmel Toolchain, 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 PATH environment variable. + * On Windows, you will need a copy of the latest Atmel Toolchain (http://www.atmel.com/tools/ATMELAVRTOOLCHAINFORWINDOWS.aspx), + * 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 PATH environment variable. * * In addition, you will need to install a ported version of the ZSH or BASH *nix shells, and a standard set of *nix * utilities such as cut, find and sed. These can be found in the "basic" system package of the * of the MinGW installer (http://www.mingw.org). Once installed, add the "msys\1.0\bin" of the MinGW installation * folder is added to your system's PATH environment variable. * - * The bootloaders currently also require the "bc" application, which can be installed from + * The bootloaders currently also require the \c bc command line application, which can be installed from * http://gnuwin32.sourceforge.net/downlinks/bc.php. Once installed add the "GnuWin32\bin" path of the GnuWin32 * installation folder to your system's PATH environment variable. * * \subsection SSec_PreqLinux Linux Prerequisites * On Linux systems you will need to install the latest Linux distribution of the standalone Atmel Toolchain from the - * Atmel website for general development, or use the latest avr-libc and avr-gcc packages for your chosen distribution's - * package manager. For full device support, the Atmel standalone package is recommended. + * Atmel website (http://www.atmel.com/tools/ATMELAVRTOOLCHAINFORLINUX.aspx), 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 * Compiling the LUFA demos, applications and/or bootloaders is very simple. LUFA comes with makefile scripts for diff --git a/LUFA/DoxygenPages/ConfiguringApps.txt b/LUFA/DoxygenPages/ConfiguringApps.txt index 976927ae0..ece9dd59b 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_AppConfigParams The Default Application Template + * \section Sec_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. * diff --git a/LUFA/DoxygenPages/VIDAndPIDValues.txt b/LUFA/DoxygenPages/VIDAndPIDValues.txt index 97a226054..7791fb2aa 100644 --- a/LUFA/DoxygenPages/VIDAndPIDValues.txt +++ b/LUFA/DoxygenPages/VIDAndPIDValues.txt @@ -17,402 +17,177 @@ * demos share the same VID/PID value. * * - * * - * - * - * + * + * + * * - * * - * - * - * - * + * + * + * + * * - * - * - * + * + * + * * - * * - * - * - * + * + * + * * - * * - * - * - * + * + * + * * - * * - * - * - * + * + * + * * - * * - * - * - * + * + * + * * - * * - * - * - * + * + * + * * - * * - * - * - * + * + * + * * - * * - * - * - * + * + * + * * - * * - * - * - * + * + * + * * - * * - * - * - * + * + * + * * - * * - * - * - * + * + * + * * - * * - * - * - * + * + * + * * - * * - * - * - * + * + * + * * - * * - * - * - * + * + * + * * - * * - * + * * - * + * * - * * - * - * - * + * + * + * * - * * - * - * - * + * + * + * * - * * - * - * - * + * + * + * * - * * - * - * - * + * + * + * * - * * - * - * - * + * + * + * * - * * - * - * - * + * + * + * * - * * - * + * * - * + * * - * * - * - * - * + * + * + * * - * * - * - * - * + * + * + * * - * * - * + * * - * + * * - * * - * - * - * + * + * + * * - * * - * - * - * + * + * + * * - * * - * - * - * + * + * + * * - * * - * - * - * + * + * + * * - * * - * - * - * + * + * + * * - * * - * - * - * + * + * + * * - * *
- * VID - * - * PID - * - * Usage - * VIDPIDUsage
- * 0x03EB - * - * 0x2040 - * - * Test VID/PID (See below) - * 0x03EB0x2040Test VID/PID (See \ref Sec_Test_VIDPID)
- * 0x03EB - * - * 0x2041 - * - * Mouse Demo Application - * 0x03EB0x2041Mouse Demo Application
- * 0x03EB - * - * 0x2042 - * - * Keyboard Demo Application - * 0x03EB0x2042Keyboard Demo Application
- * 0x03EB - * - * 0x2043 - * - * Joystick Demo Application - * 0x03EB0x2043Joystick Demo Application
- * 0x03EB - * - * 0x2044 - * - * CDC Demo Application - * 0x03EB0x2044CDC Demo Application
- * 0x03EB - * - * 0x2045 - * - * Mass Storage Demo Application - * 0x03EB0x2045Mass Storage Demo Application
- * 0x03EB - * - * 0x2046 - * - * Audio Output Demo Application - * 0x03EB0x2046Audio Output Demo Application
- * 0x03EB - * - * 0x2047 - * - * Audio Input Demo Application - * 0x03EB0x2047Audio Input Demo Application
- * 0x03EB - * - * 0x2048 - * - * MIDI Demo Application - * 0x03EB0x2048MIDI Demo Application
- * 0x03EB - * - * 0x2049 - * - * MagStripe Project - * 0x03EB0x2049MagStripe Project
- * 0x03EB - * - * 0x204A - * - * CDC Bootloader - * 0x03EB0x204ACDC Bootloader
- * 0x03EB - * - * 0x204B - * - * USB to Serial Demo Application - * 0x03EB0x204BUSB to Serial Demo Application
- * 0x03EB - * - * 0x204C - * - * RNDIS Demo Application - * 0x03EB0x204CRNDIS Demo Application
- * 0x03EB - * - * 0x204D - * - * Combined Keyboard and Mouse Demo Application - * 0x03EB0x204DCombined Keyboard and Mouse Demo Application
- * 0x03EB - * - * 0x204E - * - * Dual CDC Demo Application - * 0x03EB0x204EDual CDC Demo Application
- * 0x03EB - * 0x03EB * 0x204F * - * Generic HID Demo Application - * Generic HID Demo Application
- * 0x03EB - * - * 0x2060 - * - * Benito Programmer Project - * 0x03EB0x2060Benito Programmer Project
- * 0x03EB - * - * 0x2061 - * - * Combined Mass Storage and Keyboard Demo - * 0x03EB0x2061Combined Mass Storage and Keyboard Demo
- * 0x03EB - * - * 0x2062 - * - * Combined CDC and Mouse Demo - * 0x03EB0x2062Combined CDC and Mouse Demo
- * 0x03EB - * - * 0x2063 - * - * Mass Storage/HID Interface Datalogger Project - * 0x03EB0x2063Mass Storage/HID Interface Datalogger Project
- * 0x03EB - * - * 0x2064 - * - * Interfaceless Control-Only LUFA Devices - * 0x03EB0x2064Interfaceless Control-Only LUFA Devices
- * 0x03EB - * - * 0x2065 - * - * Test and Measurement Demo - * 0x03EB0x2065Test and Measurement Demo
- * 0x03EB - * 0x03EB * 0x2066 * - * Multiple Report Keyboard/Mouse HID Demo - * Multiple Report Keyboard/Mouse HID Demo
- * 0x03EB - * - * 0x2067 - * - * HID Class Bootloader - * 0x03EB0x2067HID Class Bootloader
- * 0x03EB - * - * 0x2068 - * - * Virtual Serial/Mass Storage Demo - * 0x03EB0x2068Virtual Serial/Mass Storage Demo
- * 0x03EB - * 0x03EB * 0x2069 * - * Webserver Project - * Webserver Project
- * 0x03EB - * - * 0x206A - * - * Media Control Project - * 0x03EB0x206AMedia Control Project
- * 0x03EB - * - * 0x206B - * - * Currently Unallocated - * 0x03EB0x206BCurrently Unallocated
- * 0x03EB - * - * 0x206C - * - * Currently Unallocated - * 0x03EB0x206CCurrently Unallocated
- * 0x03EB - * - * 0x206D - * - * Currently Unallocated - * 0x03EB0x206DCurrently Unallocated
- * 0x03EB - * - * 0x206E - * - * Currently Unallocated - * 0x03EB0x206ECurrently Unallocated
- * 0x03EB - * - * 0x206F - * - * Currently Unallocated - * 0x03EB0x206FCurrently Unallocated
* * \section Sec_Test_VIDPID The Test VID/PID Combination -- cgit v1.2.3