aboutsummaryrefslogtreecommitdiffstats
path: root/LUFA
diff options
context:
space:
mode:
authorDean Camera <dean@fourwalledcubicle.com>2012-09-23 11:09:09 +0000
committerDean Camera <dean@fourwalledcubicle.com>2012-09-23 11:09:09 +0000
commit4cd80263ff477e81ab88dc76f32103f3852a0468 (patch)
tree8444912e7ab4f14402ca930c0d84ba67d7a47880 /LUFA
parent217f1eebc16f6e0758305b270b3990fe002a5e4d (diff)
downloadlufa-4cd80263ff477e81ab88dc76f32103f3852a0468.tar.gz
lufa-4cd80263ff477e81ab88dc76f32103f3852a0468.tar.bz2
lufa-4cd80263ff477e81ab88dc76f32103f3852a0468.zip
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.
Diffstat (limited to 'LUFA')
-rw-r--r--LUFA/DoxygenPages/BuildSystem.txt2
-rw-r--r--LUFA/DoxygenPages/CompilingApps.txt12
-rw-r--r--LUFA/DoxygenPages/ConfiguringApps.txt2
-rw-r--r--LUFA/DoxygenPages/VIDAndPIDValues.txt419
4 files changed, 105 insertions, 330 deletions
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 <tt>make {TARGET_NAME}</tt>
* 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 <i>must</i>
* 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 <b>PATH</b> environment variable.
+ * 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.
*
* 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 <i>cut</i>, <i>find</i> and <i>sed</i>. These can be found in the "basic" system package of the
* 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.
*
- * 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
* <a>http://gnuwin32.sourceforge.net/downlinks/bc.php</a>. Once installed add the "GnuWin32\bin" path of the GnuWin32
* installation folder to your system's <b>PATH</b> 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 (<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
* 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.
*
* <table>
- *
* <tr>
- * <td>
- * <b>VID</b>
- * </td>
- * <td>
- * <b>PID</b>
- * </td>
- * <td>
- * <b>Usage</b>
- * </td>
+ * <th>VID</th>
+ * <th>PID</th>
+ * <th>Usage</th>
* </tr>
- *
* <tr>
- * <td>
- * 0x03EB
- * </td>
- * <td>
- * 0x2040
- * </td>
- * <td>
- * Test VID/PID (See below)
- * </td>
- *
+ * <td>0x03EB</td>
+ * <td>0x2040</td>
+ * <td>Test VID/PID (See \ref Sec_Test_VIDPID)</td>
+ * </tr>
* <tr>
- * <td>
- * 0x03EB
- * </td>
- * <td>
- * 0x2041
- * </td>
- * <td>
- * Mouse Demo Application
- * </td>
+ * <td>0x03EB</td>
+ * <td>0x2041</td>
+ * <td>Mouse Demo Application</td>
* </tr>
- *
* <tr>
- * <td>
- * 0x03EB
- * </td>
- * <td>
- * 0x2042
- * </td>
- * <td>
- * Keyboard Demo Application
- * </td>
+ * <td>0x03EB</td>
+ * <td>0x2042</td>
+ * <td>Keyboard Demo Application</td>
* </tr>
- *
* <tr>
- * <td>
- * 0x03EB
- * </td>
- * <td>
- * 0x2043
- * </td>
- * <td>
- * Joystick Demo Application
- * </td>
+ * <td>0x03EB</td>
+ * <td>0x2043</td>
+ * <td>Joystick Demo Application</td>
* </tr>
- *
* <tr>
- * <td>
- * 0x03EB
- * </td>
- * <td>
- * 0x2044
- * </td>
- * <td>
- * CDC Demo Application
- * </td>
+ * <td>0x03EB</td>
+ * <td>0x2044</td>
+ * <td>CDC Demo Application</td>
* </tr>
- *
* <tr>
- * <td>
- * 0x03EB
- * </td>
- * <td>
- * 0x2045
- * </td>
- * <td>
- * Mass Storage Demo Application
- * </td>
+ * <td>0x03EB</td>
+ * <td>0x2045</td>
+ * <td>Mass Storage Demo Application</td>
* </tr>
- *
* <tr>
- * <td>
- * 0x03EB
- * </td>
- * <td>
- * 0x2046
- * </td>
- * <td>
- * Audio Output Demo Application
- * </td>
+ * <td>0x03EB</td>
+ * <td>0x2046</td>
+ * <td>Audio Output Demo Application</td>
* </tr>
- *
* <tr>
- * <td>
- * 0x03EB
- * </td>
- * <td>
- * 0x2047
- * </td>
- * <td>
- * Audio Input Demo Application
- * </td>
+ * <td>0x03EB</td>
+ * <td>0x2047</td>
+ * <td>Audio Input Demo Application</td>
* </tr>
- *
* <tr>
- * <td>
- * 0x03EB
- * </td>
- * <td>
- * 0x2048
- * </td>
- * <td>
- * MIDI Demo Application
- * </td>
+ * <td>0x03EB</td>
+ * <td>0x2048</td>
+ * <td>MIDI Demo Application</td>
* </tr>
- *
* <tr>
- * <td>
- * 0x03EB
- * </td>
- * <td>
- * 0x2049
- * </td>
- * <td>
- * MagStripe Project
- * </td>
+ * <td>0x03EB</td>
+ * <td>0x2049</td>
+ * <td>MagStripe Project</td>
* </tr>
- *
* <tr>
- * <td>
- * 0x03EB
- * </td>
- * <td>
- * 0x204A
- * </td>
- * <td>
- * CDC Bootloader
- * </td>
+ * <td>0x03EB</td>
+ * <td>0x204A</td>
+ * <td>CDC Bootloader</td>
* </tr>
- *
* <tr>
- * <td>
- * 0x03EB
- * </td>
- * <td>
- * 0x204B
- * </td>
- * <td>
- * USB to Serial Demo Application
- * </td>
+ * <td>0x03EB</td>
+ * <td>0x204B</td>
+ * <td>USB to Serial Demo Application</td>
* </tr>
- *
* <tr>
- * <td>
- * 0x03EB
- * </td>
- * <td>
- * 0x204C
- * </td>
- * <td>
- * RNDIS Demo Application
- * </td>
+ * <td>0x03EB</td>
+ * <td>0x204C</td>
+ * <td>RNDIS Demo Application</td>
* </tr>
- *
* <tr>
- * <td>
- * 0x03EB
- * </td>
- * <td>
- * 0x204D
- * </td>
- * <td>
- * Combined Keyboard and Mouse Demo Application
- * </td>
+ * <td>0x03EB</td>
+ * <td>0x204D</td>
+ * <td>Combined Keyboard and Mouse Demo Application</td>
* </tr>
- *
* <tr>
- * <td>
- * 0x03EB
- * </td>
- * <td>
- * 0x204E
- * </td>
- * <td>
- * Dual CDC Demo Application
- * </td>
+ * <td>0x03EB</td>
+ * <td>0x204E</td>
+ * <td>Dual CDC Demo Application</td>
* </tr>
- *
* <tr>
- * <td>
- * 0x03EB
- * </td>
+ * <td>0x03EB</td>
* <td>
* 0x204F
* </td>
- * <td>
- * Generic HID Demo Application
- * </td>
+ * <td>Generic HID Demo Application</td>
* </tr>
- *
* <tr>
- * <td>
- * 0x03EB
- * </td>
- * <td>
- * 0x2060
- * </td>
- * <td>
- * Benito Programmer Project
- * </td>
+ * <td>0x03EB</td>
+ * <td>0x2060</td>
+ * <td>Benito Programmer Project</td>
* </tr>
- *
* <tr>
- * <td>
- * 0x03EB
- * </td>
- * <td>
- * 0x2061
- * </td>
- * <td>
- * Combined Mass Storage and Keyboard Demo
- * </td>
+ * <td>0x03EB</td>
+ * <td>0x2061</td>
+ * <td>Combined Mass Storage and Keyboard Demo</td>
* </tr>
- *
* <tr>
- * <td>
- * 0x03EB
- * </td>
- * <td>
- * 0x2062
- * </td>
- * <td>
- * Combined CDC and Mouse Demo
- * </td>
+ * <td>0x03EB</td>
+ * <td>0x2062</td>
+ * <td>Combined CDC and Mouse Demo</td>
* </tr>
- *
* <tr>
- * <td>
- * 0x03EB
- * </td>
- * <td>
- * 0x2063
- * </td>
- * <td>
- * Mass Storage/HID Interface Datalogger Project
- * </td>
+ * <td>0x03EB</td>
+ * <td>0x2063</td>
+ * <td>Mass Storage/HID Interface Datalogger Project</td>
* </tr>
- *
* <tr>
- * <td>
- * 0x03EB
- * </td>
- * <td>
- * 0x2064
- * </td>
- * <td>
- * Interfaceless Control-Only LUFA Devices
- * </td>
+ * <td>0x03EB</td>
+ * <td>0x2064</td>
+ * <td>Interfaceless Control-Only LUFA Devices</td>
* </tr>
- *
* <tr>
- * <td>
- * 0x03EB
- * </td>
- * <td>
- * 0x2065
- * </td>
- * <td>
- * Test and Measurement Demo
- * </td>
+ * <td>0x03EB</td>
+ * <td>0x2065</td>
+ * <td>Test and Measurement Demo</td>
* </tr>
- *
* <tr>
- * <td>
- * 0x03EB
- * </td>
+ * <td>0x03EB</td>
* <td>
* 0x2066
* </td>
- * <td>
- * Multiple Report Keyboard/Mouse HID Demo
- * </td>
+ * <td>Multiple Report Keyboard/Mouse HID Demo</td>
* </tr>
- *
* <tr>
- * <td>
- * 0x03EB
- * </td>
- * <td>
- * 0x2067
- * </td>
- * <td>
- * HID Class Bootloader
- * </td>
+ * <td>0x03EB</td>
+ * <td>0x2067</td>
+ * <td>HID Class Bootloader</td>
* </tr>
- *
* <tr>
- * <td>
- * 0x03EB
- * </td>
- * <td>
- * 0x2068
- * </td>
- * <td>
- * Virtual Serial/Mass Storage Demo
- * </td>
+ * <td>0x03EB</td>
+ * <td>0x2068</td>
+ * <td>Virtual Serial/Mass Storage Demo</td>
* </tr>
- *
* <tr>
- * <td>
- * 0x03EB
- * </td>
+ * <td>0x03EB</td>
* <td>
* 0x2069
* </td>
- * <td>
- * Webserver Project
- * </td>
+ * <td>Webserver Project</td>
* </tr>
- *
* <tr>
- * <td>
- * 0x03EB
- * </td>
- * <td>
- * 0x206A
- * </td>
- * <td>
- * Media Control Project
- * </td>
+ * <td>0x03EB</td>
+ * <td>0x206A</td>
+ * <td>Media Control Project</td>
* </tr>
- *
* <tr>
- * <td>
- * 0x03EB
- * </td>
- * <td>
- * 0x206B
- * </td>
- * <td>
- * <i>Currently Unallocated</i>
- * </td>
+ * <td>0x03EB</td>
+ * <td>0x206B</td>
+ * <td><i>Currently Unallocated</i></td>
* </tr>
- *
* <tr>
- * <td>
- * 0x03EB
- * </td>
- * <td>
- * 0x206C
- * </td>
- * <td>
- * <i>Currently Unallocated</i>
- * </td>
+ * <td>0x03EB</td>
+ * <td>0x206C</td>
+ * <td><i>Currently Unallocated</i></td>
* </tr>
- *
* <tr>
- * <td>
- * 0x03EB
- * </td>
- * <td>
- * 0x206D
- * </td>
- * <td>
- * <i>Currently Unallocated</i>
- * </td>
+ * <td>0x03EB</td>
+ * <td>0x206D</td>
+ * <td><i>Currently Unallocated</i></td>
* </tr>
- *
* <tr>
- * <td>
- * 0x03EB
- * </td>
- * <td>
- * 0x206E
- * </td>
- * <td>
- * <i>Currently Unallocated</i>
- * </td>
+ * <td>0x03EB</td>
+ * <td>0x206E</td>
+ * <td><i>Currently Unallocated</i></td>
* </tr>
- *
* <tr>
- * <td>
- * 0x03EB
- * </td>
- * <td>
- * 0x206F
- * </td>
- * <td>
- * <i>Currently Unallocated</i>
- * </td>
+ * <td>0x03EB</td>
+ * <td>0x206F</td>
+ * <td><i>Currently Unallocated</i></td>
* </tr>
- *
* </table>
*
* \section Sec_Test_VIDPID The Test VID/PID Combination