Minor documentation improvements.
authorDean Camera <dean@fourwalledcubicle.com>
Sun, 16 Jun 2013 13:09:13 +0000 (15:09 +0200)
committerDean Camera <dean@fourwalledcubicle.com>
Sun, 16 Jun 2013 13:09:13 +0000 (15:09 +0200)
23 files changed:
Bootloaders/CDC/BootloaderCDC.txt
Bootloaders/DFU/BootloaderDFU.txt
Demos/Device/ClassDriver/AudioInput/AudioInput.txt
Demos/Device/ClassDriver/AudioOutput/AudioOutput.txt
Demos/Device/ClassDriver/GenericHID/GenericHID.txt
Demos/Device/ClassDriver/MassStorage/MassStorage.txt
Demos/Device/ClassDriver/MassStorageKeyboard/MassStorageKeyboard.txt
Demos/Device/ClassDriver/RNDISEthernet/RNDISEthernet.txt
Demos/Device/ClassDriver/VirtualSerialMassStorage/VirtualSerialMassStorage.txt
Demos/Device/LowLevel/AudioInput/AudioInput.txt
Demos/Device/LowLevel/AudioOutput/AudioOutput.txt
Demos/Device/LowLevel/GenericHID/GenericHID.txt
Demos/Device/LowLevel/MassStorage/MassStorage.txt
Demos/Device/LowLevel/RNDISEthernet/RNDISEthernet.txt
Demos/Host/ClassDriver/AudioOutputHost/AudioOutputHost.txt
Demos/Host/LowLevel/AudioOutputHost/AudioOutputHost.txt
Projects/AVRISP-MKII/AVRISP-MKII.txt
Projects/Benito/Benito.txt
Projects/MIDIToneGenerator/MIDIToneGenerator.txt
Projects/Magstripe/Magstripe.txt
Projects/TempDataLogger/TemperatureDataLogger.txt
Projects/Webserver/Webserver.txt
Projects/XPLAINBridge/XPLAINBridge.txt

index 379988f..1004a83 100644 (file)
  *
  *  <table>
  *   <tr>
  *
  *  <table>
  *   <tr>
- *    <td><b>Define Name:</b></td>
- *    <td><b>Location:</b></td>
- *    <td><b>Description:</b></td>
+ *    <th><b>Define Name:</b></th>
+ *    <th><b>Location:</b></th>
+ *    <th><b>Description:</b></th>
  *   </tr>
  *   <tr>
  *    <td>NO_BLOCK_SUPPORT</td>
  *   </tr>
  *   <tr>
  *    <td>NO_BLOCK_SUPPORT</td>
index 8cba21a..b6ba455 100644 (file)
  *
  *  <table>
  *   <tr>
  *
  *  <table>
  *   <tr>
- *    <td><b>Define Name:</b></td>
- *    <td><b>Location:</b></td>
- *    <td><b>Description:</b></td>
+ *    <th><b>Define Name:</b></th>
+ *    <th><b>Location:</b></th>
+ *    <th><b>Description:</b></th>
  *   </tr>
  *   <tr>
  *    <td>SECURE_MODE</td>
  *   </tr>
  *   <tr>
  *    <td>SECURE_MODE</td>
index dfa9362..4b05942 100644 (file)
@@ -50,7 +50,7 @@
  *  basic USB Audio 1.0 drivers in all modern OSes (i.e. no special drivers
  *  required).
  *
  *  basic USB Audio 1.0 drivers in all modern OSes (i.e. no special drivers
  *  required).
  *
- *  On start-up the system will automatically enumerate and function as a 
+ *  On start-up the system will automatically enumerate and function as a
  *  USB microphone. By default, the demo will produce a square wave test tone
  *  when the board button is pressed. If USE_TEST_TONE is not defined in the
  *  project makefile, incoming audio from the ADC channel 1 will be sampled
  *  USB microphone. By default, the demo will produce a square wave test tone
  *  when the board button is pressed. If USE_TEST_TONE is not defined in the
  *  project makefile, incoming audio from the ADC channel 1 will be sampled
@@ -67,9 +67,9 @@
  *
  *  <table>
  *   <tr>
  *
  *  <table>
  *   <tr>
- *    <td><b>Define Name:</b></td>
- *    <td><b>Location:</b></td>
- *    <td><b>Description:</b></td>
+ *    <th><b>Define Name:</b></th>
+ *    <th><b>Location:</b></th>
+ *    <th><b>Description:</b></th>
  *   </tr>
  *   <tr>
  *    <td>MIC_IN_ADC_CHANNEL</td>
  *   </tr>
  *   <tr>
  *    <td>MIC_IN_ADC_CHANNEL</td>
index 76445e0..8f0c7d6 100644 (file)
@@ -67,9 +67,9 @@
  *
  *  <table>
  *   <tr>
  *
  *  <table>
  *   <tr>
- *    <td><b>Define Name:</b></td>
- *    <td><b>Location:</b></td>
- *    <td><b>Description:</b></td>
+ *    <th><b>Define Name:</b></th>
+ *    <th><b>Location:</b></th>
+ *    <th><b>Description:</b></th>
  *   </tr>
  *   <tr>
  *    <td>AUDIO_OUT_STEREO</td>
  *   </tr>
  *   <tr>
  *    <td>AUDIO_OUT_STEREO</td>
index 1402740..649fc62 100644 (file)
@@ -64,9 +64,9 @@
  *
  *  <table>
  *   <tr>
  *
  *  <table>
  *   <tr>
- *    <td><b>Define Name:</b></td>
- *    <td><b>Location:</b></td>
- *    <td><b>Description:</b></td>
+ *    <th><b>Define Name:</b></th>
+ *    <th><b>Location:</b></th>
+ *    <th><b>Description:</b></th>
  *   </tr>
  *   <tr>
  *    <td>GENERIC_REPORT_SIZE</td>
  *   </tr>
  *   <tr>
  *    <td>GENERIC_REPORT_SIZE</td>
index dd71e3b..31779e9 100644 (file)
@@ -80,9 +80,9 @@
  *
  *  <table>
  *   <tr>
  *
  *  <table>
  *   <tr>
- *    <td><b>Define Name:</b></td>
- *    <td><b>Location:</b></td>
- *    <td><b>Description:</b></td>
+ *    <th><b>Define Name:</b></th>
+ *    <th><b>Location:</b></th>
+ *    <th><b>Description:</b></th>
  *   </tr>
  *   <tr>
  *    <td>TOTAL_LUNS</td>
  *   </tr>
  *   <tr>
  *    <td>TOTAL_LUNS</td>
index d9affad..c84769a 100644 (file)
@@ -81,9 +81,9 @@
  *
  *  <table>
  *   <tr>
  *
  *  <table>
  *   <tr>
- *    <td><b>Define Name:</b></td>
- *    <td><b>Location:</b></td>
- *    <td><b>Description:</b></td>
+ *    <th><b>Define Name:</b></th>
+ *    <th><b>Location:</b></th>
+ *    <th><b>Description:</b></th>
  *   </tr>
  *   <tr>
  *    <td>TOTAL_LUNS</td>
  *   </tr>
  *   <tr>
  *    <td>TOTAL_LUNS</td>
index aafa3cc..496ab07 100644 (file)
@@ -82,9 +82,9 @@
  *
  *  <table>
  *   <tr>
  *
  *  <table>
  *   <tr>
- *    <td><b>Define Name:</b></td>
- *    <td><b>Location:</b></td>
- *    <td><b>Description:</b></td>
+ *    <th><b>Define Name:</b></th>
+ *    <th><b>Location:</b></th>
+ *    <th><b>Description:</b></th>
  *   </tr>
  *   <tr>
  *    <td>CLIENT_IP_ADDRESS</td>
  *   </tr>
  *   <tr>
  *    <td>CLIENT_IP_ADDRESS</td>
index 62a7c3d..caf83e4 100644 (file)
@@ -74,9 +74,9 @@
  *
  *  <table>
  *   <tr>
  *
  *  <table>
  *   <tr>
- *    <td><b>Define Name:</b></td>
- *    <td><b>Location:</b></td>
- *    <td><b>Description:</b></td>
+ *    <th><b>Define Name:</b></th>
+ *    <th><b>Location:</b></th>
+ *    <th><b>Description:</b></th>
  *   </tr>
  *   <tr>
  *    <td>TOTAL_LUNS</td>
  *   </tr>
  *   <tr>
  *    <td>TOTAL_LUNS</td>
index b30d7d6..9dc6c36 100644 (file)
@@ -50,7 +50,7 @@
  *  basic USB Audio 1.0 drivers in all modern OSes (i.e. no special drivers
  *  required).
  *
  *  basic USB Audio 1.0 drivers in all modern OSes (i.e. no special drivers
  *  required).
  *
- *  On start-up the system will automatically enumerate and function as a 
+ *  On start-up the system will automatically enumerate and function as a
  *  USB microphone. By default, the demo will produce a square wave test tone
  *  when the board button is pressed. If USE_TEST_TONE is not defined in the
  *  project makefile, incoming audio from the ADC channel 1 will be sampled
  *  USB microphone. By default, the demo will produce a square wave test tone
  *  when the board button is pressed. If USE_TEST_TONE is not defined in the
  *  project makefile, incoming audio from the ADC channel 1 will be sampled
@@ -67,9 +67,9 @@
  *
  *  <table>
  *   <tr>
  *
  *  <table>
  *   <tr>
- *    <td><b>Define Name:</b></td>
- *    <td><b>Location:</b></td>
- *    <td><b>Description:</b></td>
+ *    <th><b>Define Name:</b></th>
+ *    <th><b>Location:</b></th>
+ *    <th><b>Description:</b></th>
  *   </tr>
  *   <tr>
  *    <td>USE_TEST_TONE</td>
  *   </tr>
  *   <tr>
  *    <td>USE_TEST_TONE</td>
index 76445e0..8f0c7d6 100644 (file)
@@ -67,9 +67,9 @@
  *
  *  <table>
  *   <tr>
  *
  *  <table>
  *   <tr>
- *    <td><b>Define Name:</b></td>
- *    <td><b>Location:</b></td>
- *    <td><b>Description:</b></td>
+ *    <th><b>Define Name:</b></th>
+ *    <th><b>Location:</b></th>
+ *    <th><b>Description:</b></th>
  *   </tr>
  *   <tr>
  *    <td>AUDIO_OUT_STEREO</td>
  *   </tr>
  *   <tr>
  *    <td>AUDIO_OUT_STEREO</td>
index 1402740..649fc62 100644 (file)
@@ -64,9 +64,9 @@
  *
  *  <table>
  *   <tr>
  *
  *  <table>
  *   <tr>
- *    <td><b>Define Name:</b></td>
- *    <td><b>Location:</b></td>
- *    <td><b>Description:</b></td>
+ *    <th><b>Define Name:</b></th>
+ *    <th><b>Location:</b></th>
+ *    <th><b>Description:</b></th>
  *   </tr>
  *   <tr>
  *    <td>GENERIC_REPORT_SIZE</td>
  *   </tr>
  *   <tr>
  *    <td>GENERIC_REPORT_SIZE</td>
index 528dbe7..e544634 100644 (file)
@@ -80,9 +80,9 @@
  *
  *  <table>
  *   <tr>
  *
  *  <table>
  *   <tr>
- *    <td><b>Define Name:</b></td>
- *    <td><b>Location:</b></td>
- *    <td><b>Description:</b></td>
+ *    <th><b>Define Name:</b></th>
+ *    <th><b>Location:</b></th>
+ *    <th><b>Description:</b></th>
  *   </tr>
  *   <tr>
  *    <td>TOTAL_LUNS</td>
  *   </tr>
  *   <tr>
  *    <td>TOTAL_LUNS</td>
index aafa3cc..496ab07 100644 (file)
@@ -82,9 +82,9 @@
  *
  *  <table>
  *   <tr>
  *
  *  <table>
  *   <tr>
- *    <td><b>Define Name:</b></td>
- *    <td><b>Location:</b></td>
- *    <td><b>Description:</b></td>
+ *    <th><b>Define Name:</b></th>
+ *    <th><b>Location:</b></th>
+ *    <th><b>Description:</b></th>
  *   </tr>
  *   <tr>
  *    <td>CLIENT_IP_ADDRESS</td>
  *   </tr>
  *   <tr>
  *    <td>CLIENT_IP_ADDRESS</td>
index 3af62bc..5e79a33 100644 (file)
@@ -58,9 +58,9 @@
  *
  *  <table>
  *   <tr>
  *
  *  <table>
  *   <tr>
- *    <td><b>Define Name:</b></td>
- *    <td><b>Location:</b></td>
- *    <td><b>Description:</b></td>
+ *    <th><b>Define Name:</b></th>
+ *    <th><b>Location:</b></th>
+ *    <th><b>Description:</b></th>
  *   </tr>
  *   <tr>
  *    <td>MIC_IN_ADC_CHANNEL</td>
  *   </tr>
  *   <tr>
  *    <td>MIC_IN_ADC_CHANNEL</td>
index 3af62bc..5e79a33 100644 (file)
@@ -58,9 +58,9 @@
  *
  *  <table>
  *   <tr>
  *
  *  <table>
  *   <tr>
- *    <td><b>Define Name:</b></td>
- *    <td><b>Location:</b></td>
- *    <td><b>Description:</b></td>
+ *    <th><b>Define Name:</b></th>
+ *    <th><b>Location:</b></th>
+ *    <th><b>Description:</b></th>
  *   </tr>
  *   <tr>
  *    <td>MIC_IN_ADC_CHANNEL</td>
  *   </tr>
  *   <tr>
  *    <td>MIC_IN_ADC_CHANNEL</td>
index ad36e72..d3d5680 100644 (file)
  *  with your compiled copy of AVRDude, or create them using the libUSB-Win32 (http://sourceforge.net/projects/libusb-win32)
  *  project.
  *
  *  with your compiled copy of AVRDude, or create them using the libUSB-Win32 (http://sourceforge.net/projects/libusb-win32)
  *  project.
  *
- *  For convenience, the programmer will report two different serial numbers depending on the firmware compatibity mode, so
+ *  For convenience, the programmer will report two different serial numbers depending on the firmware compatibility mode, so
  *  that the correct driver can be installed for the matching firmware. If the \c RESET_TOGGLES_LIBUSB_COMPAT compile option
  *  is used (see \ref Sec_Options) this allows for an easy way to automatically switch device drivers along with the firmware
  *  that the correct driver can be installed for the matching firmware. If the \c RESET_TOGGLES_LIBUSB_COMPAT compile option
  *  is used (see \ref Sec_Options) this allows for an easy way to automatically switch device drivers along with the firmware
- *  compatibility mode.
+ *  compatibility mode. The serials are:
+ *
+ *  <table>
+ *   <tr>
+ *    <th><b>Serial Number:</b></th>
+ *    <th><b>Compatibility Mode:</b></th>
+ *   </tr>
+ *   <tr>
+ *    <td>000200012345</td>
+ *    <td>Jungo (Atmel Studio) Compatibility</td>
+ *   </tr>
+ *   <tr>
+ *    <td>000200112345</td>
+ *    <td>libUSB Compatibility</td>
+ *   </tr>
+ *  </table>
  *
  *  \section Sec_ISP ISP Connections
  *  Connections to the device for SPI programming (when enabled):
  *
  *  <table>
  *   <tr>
  *
  *  \section Sec_ISP ISP Connections
  *  Connections to the device for SPI programming (when enabled):
  *
  *  <table>
  *   <tr>
- *    <td><b>Programmer Pin:</b></td>
- *    <td><b>Target Device Pin:</b></td>
- *    <td><b>ISP 6 Pin Layout:</b></td>
+ *    <th><b>Programmer Pin:</b></th>
+ *    <th><b>Target Device Pin:</b></th>
+ *    <th><b>ISP 6 Pin Layout:</b></th>
  *   </tr>
  *   <tr>
  *    <td>MISO</td>
  *   </tr>
  *   <tr>
  *    <td>MISO</td>
  *
  *  <table>
  *   <tr>
  *
  *  <table>
  *   <tr>
- *    <td><b>Programmer Pin:</b></td>
- *    <td><b>Target Device Pin:</b></td>
- *    <td><b>PDI 6 Pin Layout:</b></td>
+ *    <th><b>Programmer Pin:</b></th>
+ *    <th><b>Target Device Pin:</b></th>
+ *    <th><b>PDI 6 Pin Layout:</b></th>
  *   </tr>
  *   <tr>
  *    <td>Tx/Rx <b><sup>2</sup></b></td>
  *   </tr>
  *   <tr>
  *    <td>Tx/Rx <b><sup>2</sup></b></td>
  *
  *  <table>
  *   <tr>
  *
  *  <table>
  *   <tr>
- *    <td><b>Programmer Pin:</b></td>
- *    <td><b>Target Device Pin:</b></td>
- *    <td><b>TPI 6 Pin Layout:</b></td>
+ *    <th><b>Programmer Pin:</b></th>
+ *    <th><b>Target Device Pin:</b></th>
+ *    <th><b>TPI 6 Pin Layout:</b></th>
  *   </tr>
  *   <tr>
  *    <td>Tx/Rx <b><sup>2</sup></b></td>
  *   </tr>
  *   <tr>
  *    <td>Tx/Rx <b><sup>2</sup></b></td>
  *
  *  <table>
  *   <tr>
  *
  *  <table>
  *   <tr>
- *    <td><b>Define Name:</b></td>
- *    <td><b>Location:</b></td>
- *    <td><b>Description:</b></td>
+ *    <th><b>Define Name:</b></th>
+ *    <th><b>Location:</b></th>
+ *    <th><b>Description:</b></th>
  *   </tr>
  *   <tr>
  *    <td>AUX_LINE_PORT</td>
  *   </tr>
  *   <tr>
  *    <td>AUX_LINE_PORT</td>
index 3712961..07bec52 100644 (file)
@@ -62,9 +62,9 @@
  *
  *  <table>
  *   <tr>
  *
  *  <table>
  *   <tr>
- *    <td><b>Define Name:</b></td>
- *    <td><b>Location:</b></td>
- *    <td><b>Description:</b></td>
+ *    <th><b>Define Name:</b></th>
+ *    <th><b>Location:</b></th>
+ *    <th><b>Description:</b></th>
  *   </tr>
  *   <tr>
  *    <td>AVR_RESET_LINE_PORT</td>
  *   </tr>
  *   <tr>
  *    <td>AVR_RESET_LINE_PORT</td>
index 82510db..7d0f019 100644 (file)
@@ -58,9 +58,9 @@
  *
  *  <table>
  *   <tr>
  *
  *  <table>
  *   <tr>
- *    <td><b>Define Name:</b></td>
- *    <td><b>Location:</b></td>
- *    <td><b>Description:</b></td>
+ *    <th><b>Define Name:</b></th>
+ *    <th><b>Location:</b></th>
+ *    <th><b>Description:</b></th>
  *   </tr>
  *   <tr>
  *    <td>MAX_SIMULTANEOUS_NOTES</td>
  *   </tr>
  *   <tr>
  *    <td>MAX_SIMULTANEOUS_NOTES</td>
index 9c39cbf..a11dfaf 100644 (file)
@@ -54,8 +54,8 @@
  *
  *  <table>
  *   <tr>
  *
  *  <table>
  *   <tr>
- *    <td><b>Signal:</b></td>
- *    <td><b>AVR Port:</b></td>
+ *    <th><b>Signal:</b></th>
+ *    <th><b>AVR Port:</b></th>
  *   </tr>
  *   <tr>
  *    <td>Track 1 Data</td>
  *   </tr>
  *   <tr>
  *    <td>Track 1 Data</td>
@@ -99,9 +99,9 @@
  *
  *  <table>
  *   <tr>
  *
  *  <table>
  *   <tr>
- *    <td><b>Define Name:</b></td>
- *    <td><b>Location:</b></td>
- *    <td><b>Description:</b></td>
+ *    <th><b>Define Name:</b></th>
+ *    <th><b>Location:</b></th>
+ *    <th><b>Description:</b></th>
  *   </tr>
  *   <tr>
  *    <td>MAX_BITS</td>
  *   </tr>
  *   <tr>
  *    <td>MAX_BITS</td>
index 39eb23d..3daaa2a 100644 (file)
@@ -71,9 +71,9 @@
  *
  *  <table>
  *   <tr>
  *
  *  <table>
  *   <tr>
- *    <td><b>Define Name:</b></td>
- *    <td><b>Location:</b></td>
- *    <td><b>Description:</b></td>
+ *    <th><b>Define Name:</b></th>
+ *    <th><b>Location:</b></th>
+ *    <th><b>Description:</b></th>
  *   </tr>
  *   <tr>
  *    <td>DUMMY_RTC</td>
  *   </tr>
  *   <tr>
  *    <td>DUMMY_RTC</td>
index 2ec8369..10aa716 100644 (file)
@@ -75,9 +75,9 @@
  *
  *  <table>
  *   <tr>
  *
  *  <table>
  *   <tr>
- *    <td><b>Define Name:</b></td>
- *    <td><b>Location:</b></td>
- *    <td><b>Description:</b></td>
+ *    <th><b>Define Name:</b></th>
+ *    <th><b>Location:</b></th>
+ *    <th><b>Description:</b></th>
  *   </tr>
  *   <tr>
  *    <td>ENABLE_TELNET_SERVER</td>
  *   </tr>
  *   <tr>
  *    <td>ENABLE_TELNET_SERVER</td>
index bc0ca37..45557ef 100644 (file)
@@ -74,9 +74,9 @@
  *
  *  <table>
  *   <tr>
  *
  *  <table>
  *   <tr>
- *    <td><b>Define Name:</b></td>
- *    <td><b>Location:</b></td>
- *    <td><b>Description:</b></td>
+ *    <th><b>Define Name:</b></th>
+ *    <th><b>Location:</b></th>
+ *    <th><b>Description:</b></th>
  *   </tr>
  *   <tr>
  *    <td>LIBUSB_DRIVER_COMPAT</td>
  *   </tr>
  *   <tr>
  *    <td>LIBUSB_DRIVER_COMPAT</td>