Minor documentation improvements.

2013-06-16 15:09:13 +02:00 · 2013-06-16 15:09:13 +02:00 · 1d49fc7dd8
parent 1509af922b
commit 1d49fc7dd8
23 changed files with 99 additions and 84 deletions
--- a/Bootloaders/CDC/BootloaderCDC.txt
+++ b/Bootloaders/CDC/BootloaderCDC.txt
@ -187,9 +187,9 @@
 *
 *  <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>
--- a/Bootloaders/DFU/BootloaderDFU.txt
+++ b/Bootloaders/DFU/BootloaderDFU.txt
@ -201,9 +201,9 @@
 *
 *  <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>
--- a/Demos/Device/ClassDriver/AudioInput/AudioInput.txt
+++ b/Demos/Device/ClassDriver/AudioInput/AudioInput.txt
@ -50,7 +50,7 @@
 *  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
@ -67,9 +67,9 @@
 *
 *  <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>
--- a/Demos/Device/ClassDriver/AudioOutput/AudioOutput.txt
+++ b/Demos/Device/ClassDriver/AudioOutput/AudioOutput.txt
@ -67,9 +67,9 @@
 *
 *  <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>
--- a/Demos/Device/ClassDriver/GenericHID/GenericHID.txt
+++ b/Demos/Device/ClassDriver/GenericHID/GenericHID.txt
@ -64,9 +64,9 @@
 *
 *  <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>
--- a/Demos/Device/ClassDriver/MassStorage/MassStorage.txt
+++ b/Demos/Device/ClassDriver/MassStorage/MassStorage.txt
@ -80,9 +80,9 @@
 *
 *  <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>
--- a/Demos/Device/ClassDriver/MassStorageKeyboard/MassStorageKeyboard.txt
+++ b/Demos/Device/ClassDriver/MassStorageKeyboard/MassStorageKeyboard.txt
@ -81,9 +81,9 @@
 *
 *  <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>
--- a/Demos/Device/ClassDriver/RNDISEthernet/RNDISEthernet.txt
+++ b/Demos/Device/ClassDriver/RNDISEthernet/RNDISEthernet.txt
@ -82,9 +82,9 @@
 *
 *  <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>
--- a/Demos/Device/ClassDriver/VirtualSerialMassStorage/VirtualSerialMassStorage.txt
+++ b/Demos/Device/ClassDriver/VirtualSerialMassStorage/VirtualSerialMassStorage.txt
@ -74,9 +74,9 @@
 *
 *  <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>
--- a/Demos/Device/LowLevel/AudioInput/AudioInput.txt
+++ b/Demos/Device/LowLevel/AudioInput/AudioInput.txt
@ -50,7 +50,7 @@
 *  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
@ -67,9 +67,9 @@
 *
 *  <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>
--- a/Demos/Device/LowLevel/AudioOutput/AudioOutput.txt
+++ b/Demos/Device/LowLevel/AudioOutput/AudioOutput.txt
@ -67,9 +67,9 @@
 *
 *  <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>
--- a/Demos/Device/LowLevel/GenericHID/GenericHID.txt
+++ b/Demos/Device/LowLevel/GenericHID/GenericHID.txt
@ -64,9 +64,9 @@
 *
 *  <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>
--- a/Demos/Device/LowLevel/MassStorage/MassStorage.txt
+++ b/Demos/Device/LowLevel/MassStorage/MassStorage.txt
@ -80,9 +80,9 @@
 *
 *  <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>
--- a/Demos/Device/LowLevel/RNDISEthernet/RNDISEthernet.txt
+++ b/Demos/Device/LowLevel/RNDISEthernet/RNDISEthernet.txt
@ -82,9 +82,9 @@
 *
 *  <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>
--- a/Demos/Host/ClassDriver/AudioOutputHost/AudioOutputHost.txt
+++ b/Demos/Host/ClassDriver/AudioOutputHost/AudioOutputHost.txt
@ -58,9 +58,9 @@
 *
 *  <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>
--- a/Demos/Host/LowLevel/AudioOutputHost/AudioOutputHost.txt
+++ b/Demos/Host/LowLevel/AudioOutputHost/AudioOutputHost.txt
@ -58,9 +58,9 @@
 *
 *  <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>
--- a/Projects/AVRISP-MKII/AVRISP-MKII.txt
+++ b/Projects/AVRISP-MKII/AVRISP-MKII.txt
@ -87,19 +87,34 @@
 *  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
- *  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>
- *    <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>
@ -145,9 +160,9 @@
 *
 *  <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>
@ -189,9 +204,9 @@
 *
 *  <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>
@ -235,9 +250,9 @@
 *
 *  <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>
--- a/Projects/Benito/Benito.txt
+++ b/Projects/Benito/Benito.txt
@ -62,9 +62,9 @@
 *
 *  <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>
--- a/Projects/MIDIToneGenerator/MIDIToneGenerator.txt
+++ b/Projects/MIDIToneGenerator/MIDIToneGenerator.txt
@ -58,9 +58,9 @@
 *
 *  <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>
--- a/Projects/Magstripe/Magstripe.txt
+++ b/Projects/Magstripe/Magstripe.txt
@ -54,8 +54,8 @@
 *
 *  <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>
@ -99,9 +99,9 @@
 *
 *  <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>
--- a/Projects/TempDataLogger/TemperatureDataLogger.txt
+++ b/Projects/TempDataLogger/TemperatureDataLogger.txt
@ -71,9 +71,9 @@
 *
 *  <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>
--- a/Projects/Webserver/Webserver.txt
+++ b/Projects/Webserver/Webserver.txt
@ -75,9 +75,9 @@
 *
 *  <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>
--- a/Projects/XPLAINBridge/XPLAINBridge.txt
+++ b/Projects/XPLAINBridge/XPLAINBridge.txt
@ -74,9 +74,9 @@
 *
 *  <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>