From 1d49fc7dd829ecd49a286bcb4ec2c0ba46a0380c Mon Sep 17 00:00:00 2001 From: Dean Camera Date: Sun, 16 Jun 2013 15:09:13 +0200 Subject: [PATCH] Minor documentation improvements. --- Bootloaders/CDC/BootloaderCDC.txt | 6 +-- Bootloaders/DFU/BootloaderDFU.txt | 6 +-- .../ClassDriver/AudioInput/AudioInput.txt | 8 ++-- .../ClassDriver/AudioOutput/AudioOutput.txt | 6 +-- .../ClassDriver/GenericHID/GenericHID.txt | 6 +-- .../ClassDriver/MassStorage/MassStorage.txt | 6 +-- .../MassStorageKeyboard.txt | 6 +-- .../RNDISEthernet/RNDISEthernet.txt | 6 +-- .../VirtualSerialMassStorage.txt | 6 +-- .../Device/LowLevel/AudioInput/AudioInput.txt | 8 ++-- .../LowLevel/AudioOutput/AudioOutput.txt | 6 +-- .../Device/LowLevel/GenericHID/GenericHID.txt | 6 +-- .../LowLevel/MassStorage/MassStorage.txt | 6 +-- .../LowLevel/RNDISEthernet/RNDISEthernet.txt | 6 +-- .../AudioOutputHost/AudioOutputHost.txt | 6 +-- .../AudioOutputHost/AudioOutputHost.txt | 6 +-- Projects/AVRISP-MKII/AVRISP-MKII.txt | 43 +++++++++++++------ Projects/Benito/Benito.txt | 6 +-- .../MIDIToneGenerator/MIDIToneGenerator.txt | 6 +-- Projects/Magstripe/Magstripe.txt | 10 ++--- .../TempDataLogger/TemperatureDataLogger.txt | 6 +-- Projects/Webserver/Webserver.txt | 6 +-- Projects/XPLAINBridge/XPLAINBridge.txt | 6 +-- 23 files changed, 99 insertions(+), 84 deletions(-) diff --git a/Bootloaders/CDC/BootloaderCDC.txt b/Bootloaders/CDC/BootloaderCDC.txt index 379988f9e9..1004a83f32 100644 --- a/Bootloaders/CDC/BootloaderCDC.txt +++ b/Bootloaders/CDC/BootloaderCDC.txt @@ -187,9 +187,9 @@ * * * - * - * - * + * + * + * * * * diff --git a/Bootloaders/DFU/BootloaderDFU.txt b/Bootloaders/DFU/BootloaderDFU.txt index 8cba21a911..b6ba45553e 100644 --- a/Bootloaders/DFU/BootloaderDFU.txt +++ b/Bootloaders/DFU/BootloaderDFU.txt @@ -201,9 +201,9 @@ * *
Define Name:Location:Description:Define Name:Location:Description:
NO_BLOCK_SUPPORT
* - * - * - * + * + * + * * * * diff --git a/Demos/Device/ClassDriver/AudioInput/AudioInput.txt b/Demos/Device/ClassDriver/AudioInput/AudioInput.txt index dfa9362c25..4b0594244d 100644 --- 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 @@ * *
Define Name:Location:Description:Define Name:Location:Description:
SECURE_MODE
* - * - * - * + * + * + * * * * diff --git a/Demos/Device/ClassDriver/AudioOutput/AudioOutput.txt b/Demos/Device/ClassDriver/AudioOutput/AudioOutput.txt index 76445e0e2d..8f0c7d656c 100644 --- a/Demos/Device/ClassDriver/AudioOutput/AudioOutput.txt +++ b/Demos/Device/ClassDriver/AudioOutput/AudioOutput.txt @@ -67,9 +67,9 @@ * *
Define Name:Location:Description:Define Name:Location:Description:
MIC_IN_ADC_CHANNEL
* - * - * - * + * + * + * * * * diff --git a/Demos/Device/ClassDriver/GenericHID/GenericHID.txt b/Demos/Device/ClassDriver/GenericHID/GenericHID.txt index 1402740399..649fc62ce4 100644 --- a/Demos/Device/ClassDriver/GenericHID/GenericHID.txt +++ b/Demos/Device/ClassDriver/GenericHID/GenericHID.txt @@ -64,9 +64,9 @@ * *
Define Name:Location:Description:Define Name:Location:Description:
AUDIO_OUT_STEREO
* - * - * - * + * + * + * * * * diff --git a/Demos/Device/ClassDriver/MassStorage/MassStorage.txt b/Demos/Device/ClassDriver/MassStorage/MassStorage.txt index dd71e3bcd6..31779e9c02 100644 --- a/Demos/Device/ClassDriver/MassStorage/MassStorage.txt +++ b/Demos/Device/ClassDriver/MassStorage/MassStorage.txt @@ -80,9 +80,9 @@ * *
Define Name:Location:Description:Define Name:Location:Description:
GENERIC_REPORT_SIZE
* - * - * - * + * + * + * * * * diff --git a/Demos/Device/ClassDriver/MassStorageKeyboard/MassStorageKeyboard.txt b/Demos/Device/ClassDriver/MassStorageKeyboard/MassStorageKeyboard.txt index d9affad832..c84769ade1 100644 --- a/Demos/Device/ClassDriver/MassStorageKeyboard/MassStorageKeyboard.txt +++ b/Demos/Device/ClassDriver/MassStorageKeyboard/MassStorageKeyboard.txt @@ -81,9 +81,9 @@ * *
Define Name:Location:Description:Define Name:Location:Description:
TOTAL_LUNS
* - * - * - * + * + * + * * * * diff --git a/Demos/Device/ClassDriver/RNDISEthernet/RNDISEthernet.txt b/Demos/Device/ClassDriver/RNDISEthernet/RNDISEthernet.txt index aafa3cc439..496ab07a1d 100644 --- a/Demos/Device/ClassDriver/RNDISEthernet/RNDISEthernet.txt +++ b/Demos/Device/ClassDriver/RNDISEthernet/RNDISEthernet.txt @@ -82,9 +82,9 @@ * *
Define Name:Location:Description:Define Name:Location:Description:
TOTAL_LUNS
* - * - * - * + * + * + * * * * diff --git a/Demos/Device/ClassDriver/VirtualSerialMassStorage/VirtualSerialMassStorage.txt b/Demos/Device/ClassDriver/VirtualSerialMassStorage/VirtualSerialMassStorage.txt index 62a7c3da68..caf83e499d 100644 --- a/Demos/Device/ClassDriver/VirtualSerialMassStorage/VirtualSerialMassStorage.txt +++ b/Demos/Device/ClassDriver/VirtualSerialMassStorage/VirtualSerialMassStorage.txt @@ -74,9 +74,9 @@ * *
Define Name:Location:Description:Define Name:Location:Description:
CLIENT_IP_ADDRESS
* - * - * - * + * + * + * * * * diff --git a/Demos/Device/LowLevel/AudioInput/AudioInput.txt b/Demos/Device/LowLevel/AudioInput/AudioInput.txt index b30d7d63ee..9dc6c36b88 100644 --- 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 @@ * *
Define Name:Location:Description:Define Name:Location:Description:
TOTAL_LUNS
* - * - * - * + * + * + * * * * diff --git a/Demos/Device/LowLevel/AudioOutput/AudioOutput.txt b/Demos/Device/LowLevel/AudioOutput/AudioOutput.txt index 76445e0e2d..8f0c7d656c 100644 --- a/Demos/Device/LowLevel/AudioOutput/AudioOutput.txt +++ b/Demos/Device/LowLevel/AudioOutput/AudioOutput.txt @@ -67,9 +67,9 @@ * *
Define Name:Location:Description:Define Name:Location:Description:
USE_TEST_TONE
* - * - * - * + * + * + * * * * diff --git a/Demos/Device/LowLevel/GenericHID/GenericHID.txt b/Demos/Device/LowLevel/GenericHID/GenericHID.txt index 1402740399..649fc62ce4 100644 --- a/Demos/Device/LowLevel/GenericHID/GenericHID.txt +++ b/Demos/Device/LowLevel/GenericHID/GenericHID.txt @@ -64,9 +64,9 @@ * *
Define Name:Location:Description:Define Name:Location:Description:
AUDIO_OUT_STEREO
* - * - * - * + * + * + * * * * diff --git a/Demos/Device/LowLevel/MassStorage/MassStorage.txt b/Demos/Device/LowLevel/MassStorage/MassStorage.txt index 528dbe7536..e544634142 100644 --- a/Demos/Device/LowLevel/MassStorage/MassStorage.txt +++ b/Demos/Device/LowLevel/MassStorage/MassStorage.txt @@ -80,9 +80,9 @@ * *
Define Name:Location:Description:Define Name:Location:Description:
GENERIC_REPORT_SIZE
* - * - * - * + * + * + * * * * diff --git a/Demos/Device/LowLevel/RNDISEthernet/RNDISEthernet.txt b/Demos/Device/LowLevel/RNDISEthernet/RNDISEthernet.txt index aafa3cc439..496ab07a1d 100644 --- a/Demos/Device/LowLevel/RNDISEthernet/RNDISEthernet.txt +++ b/Demos/Device/LowLevel/RNDISEthernet/RNDISEthernet.txt @@ -82,9 +82,9 @@ * *
Define Name:Location:Description:Define Name:Location:Description:
TOTAL_LUNS
* - * - * - * + * + * + * * * * diff --git a/Demos/Host/ClassDriver/AudioOutputHost/AudioOutputHost.txt b/Demos/Host/ClassDriver/AudioOutputHost/AudioOutputHost.txt index 3af62bc5c3..5e79a33e38 100644 --- a/Demos/Host/ClassDriver/AudioOutputHost/AudioOutputHost.txt +++ b/Demos/Host/ClassDriver/AudioOutputHost/AudioOutputHost.txt @@ -58,9 +58,9 @@ * *
Define Name:Location:Description:Define Name:Location:Description:
CLIENT_IP_ADDRESS
* - * - * - * + * + * + * * * * diff --git a/Demos/Host/LowLevel/AudioOutputHost/AudioOutputHost.txt b/Demos/Host/LowLevel/AudioOutputHost/AudioOutputHost.txt index 3af62bc5c3..5e79a33e38 100644 --- a/Demos/Host/LowLevel/AudioOutputHost/AudioOutputHost.txt +++ b/Demos/Host/LowLevel/AudioOutputHost/AudioOutputHost.txt @@ -58,9 +58,9 @@ * *
Define Name:Location:Description:Define Name:Location:Description:
MIC_IN_ADC_CHANNEL
* - * - * - * + * + * + * * * * diff --git a/Projects/AVRISP-MKII/AVRISP-MKII.txt b/Projects/AVRISP-MKII/AVRISP-MKII.txt index ad36e72799..d3d568072e 100644 --- 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: + * + *
Define Name:Location:Description:Define Name:Location:Description:
MIC_IN_ADC_CHANNEL
+ * + * + * + * + * + * + * + * + * + * + * + * + *
Serial Number:Compatibility Mode:
000200012345Jungo (Atmel Studio) Compatibility
000200112345libUSB Compatibility
* * \section Sec_ISP ISP Connections * Connections to the device for SPI programming (when enabled): * * * - * - * - * + * + * + * * * * @@ -145,9 +160,9 @@ * *
Programmer Pin:Target Device Pin:ISP 6 Pin Layout:Programmer Pin:Target Device Pin:ISP 6 Pin Layout:
MISO
* - * - * - * + * + * + * * * * @@ -189,9 +204,9 @@ * *
Programmer Pin:Target Device Pin:PDI 6 Pin Layout:Programmer Pin:Target Device Pin:PDI 6 Pin Layout:
Tx/Rx 2
* - * - * - * + * + * + * * * * @@ -235,9 +250,9 @@ * *
Programmer Pin:Target Device Pin:TPI 6 Pin Layout:Programmer Pin:Target Device Pin:TPI 6 Pin Layout:
Tx/Rx 2
* - * - * - * + * + * + * * * * diff --git a/Projects/Benito/Benito.txt b/Projects/Benito/Benito.txt index 3712961398..07bec52b3a 100644 --- a/Projects/Benito/Benito.txt +++ b/Projects/Benito/Benito.txt @@ -62,9 +62,9 @@ * *
Define Name:Location:Description:Define Name:Location:Description:
AUX_LINE_PORT
* - * - * - * + * + * + * * * * diff --git a/Projects/MIDIToneGenerator/MIDIToneGenerator.txt b/Projects/MIDIToneGenerator/MIDIToneGenerator.txt index 82510dba98..7d0f019ee5 100644 --- a/Projects/MIDIToneGenerator/MIDIToneGenerator.txt +++ b/Projects/MIDIToneGenerator/MIDIToneGenerator.txt @@ -58,9 +58,9 @@ * *
Define Name:Location:Description:Define Name:Location:Description:
AVR_RESET_LINE_PORT
* - * - * - * + * + * + * * * * diff --git a/Projects/Magstripe/Magstripe.txt b/Projects/Magstripe/Magstripe.txt index 9c39cbf0a3..a11dfaf804 100644 --- a/Projects/Magstripe/Magstripe.txt +++ b/Projects/Magstripe/Magstripe.txt @@ -54,8 +54,8 @@ * *
Define Name:Location:Description:Define Name:Location:Description:
MAX_SIMULTANEOUS_NOTES
* - * - * + * + * * * * @@ -99,9 +99,9 @@ * *
Signal:AVR Port:Signal:AVR Port:
Track 1 Data
* - * - * - * + * + * + * * * * diff --git a/Projects/TempDataLogger/TemperatureDataLogger.txt b/Projects/TempDataLogger/TemperatureDataLogger.txt index 39eb23da03..3daaa2a70b 100644 --- a/Projects/TempDataLogger/TemperatureDataLogger.txt +++ b/Projects/TempDataLogger/TemperatureDataLogger.txt @@ -71,9 +71,9 @@ * *
Define Name:Location:Description:Define Name:Location:Description:
MAX_BITS
* - * - * - * + * + * + * * * * diff --git a/Projects/Webserver/Webserver.txt b/Projects/Webserver/Webserver.txt index 2ec8369062..10aa716528 100644 --- a/Projects/Webserver/Webserver.txt +++ b/Projects/Webserver/Webserver.txt @@ -75,9 +75,9 @@ * *
Define Name:Location:Description:Define Name:Location:Description:
DUMMY_RTC
* - * - * - * + * + * + * * * * diff --git a/Projects/XPLAINBridge/XPLAINBridge.txt b/Projects/XPLAINBridge/XPLAINBridge.txt index bc0ca37d80..45557ef976 100644 --- a/Projects/XPLAINBridge/XPLAINBridge.txt +++ b/Projects/XPLAINBridge/XPLAINBridge.txt @@ -74,9 +74,9 @@ * *
Define Name:Location:Description:Define Name:Location:Description:
ENABLE_TELNET_SERVER
* - * - * - * + * + * + * * * *
Define Name:Location:Description:Define Name:Location:Description:
LIBUSB_DRIVER_COMPAT