diff options
author | Dean Camera <dean@fourwalledcubicle.com> | 2010-12-26 14:55:26 +0000 |
---|---|---|
committer | Dean Camera <dean@fourwalledcubicle.com> | 2010-12-26 14:55:26 +0000 |
commit | a8b66f318dda3cc18dfcedaa3af3d01ab68b82e8 (patch) | |
tree | 3f3e7d02bfebc4bab83983e96e84f5e04d044d02 /Projects | |
parent | 2073b96d82433607bd287e3b6529fd0d3cc428cd (diff) | |
download | lufa-a8b66f318dda3cc18dfcedaa3af3d01ab68b82e8.tar.gz lufa-a8b66f318dda3cc18dfcedaa3af3d01ab68b82e8.tar.bz2 lufa-a8b66f318dda3cc18dfcedaa3af3d01ab68b82e8.zip |
Documentation improvements - put driver example code into its own section, fix incorrect and missing section names.
Diffstat (limited to 'Projects')
-rw-r--r-- | Projects/AVRISP-MKII/AVRISP-MKII.txt | 18 | ||||
-rw-r--r-- | Projects/Benito/Benito.txt | 8 | ||||
-rw-r--r-- | Projects/LEDNotifier/LEDNotifier.txt | 8 | ||||
-rw-r--r-- | Projects/MIDIToneGenerator/MIDIToneGenerator.txt | 8 | ||||
-rw-r--r-- | Projects/Magstripe/Magstripe.txt | 8 | ||||
-rw-r--r-- | Projects/MissileLauncher/MissileLauncher.txt | 8 | ||||
-rw-r--r-- | Projects/RelayBoard/RelayBoard.txt | 6 | ||||
-rw-r--r-- | Projects/TempDataLogger/TemperatureDataLogger.txt | 10 | ||||
-rw-r--r-- | Projects/USBtoSerial/USBtoSerial.txt | 8 | ||||
-rw-r--r-- | Projects/Webserver/Webserver.txt | 12 | ||||
-rw-r--r-- | Projects/XPLAINBridge/XPLAINBridge.txt | 8 |
11 files changed, 51 insertions, 51 deletions
diff --git a/Projects/AVRISP-MKII/AVRISP-MKII.txt b/Projects/AVRISP-MKII/AVRISP-MKII.txt index 7489cf6a0..fb6411b58 100644 --- a/Projects/AVRISP-MKII/AVRISP-MKII.txt +++ b/Projects/AVRISP-MKII/AVRISP-MKII.txt @@ -6,7 +6,7 @@ /** \mainpage AVRISP MKII Programmer Project * - * \section SSec_Compat Project Compatibility: + * \section Sec_Compat Project Compatibility: * * The following list indicates what microcontrollers are compatible with this project. * @@ -15,7 +15,7 @@ * - Series 4 USB AVRs (ATMEGAxxU4) * - Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2) - <i>8KB versions with reduced features only</i> * - * \section SSec_Info USB Information: + * \section Sec_Info USB Information: * * The following table gives a rundown of the USB utilization of this project. * @@ -42,7 +42,7 @@ * </tr> * </table> * - * \section SSec_Description Project Description: + * \section Sec_Description Project Description: * * Firmware for an AVRStudio compatible AVRISP-MKII clone programmer. This project will enable the USB AVR series of * microcontrollers to act as a clone of the official Atmel AVRISP-MKII programmer, usable within AVRStudio. In its @@ -109,8 +109,8 @@ * fuses have been mis-set. To use the recovery clock, connect the OCR1A pin of the USB AVR to the target AVR's * XTAL1 pin, and set the ISP programming speed to 125KHz (note: other ISP speeds will not work correctly). * - * <b><sup>1</sup></b> <i>Optional, see \ref SSec_Options section - for USB AVRs with ADC modules only</i> \n - * <b><sup>2</sup></b> <i>See AUX line related tokens in the \ref SSec_Options section</i> + * <b><sup>1</sup></b> <i>Optional, see \ref Sec_Options section - for USB AVRs with ADC modules only</i> \n + * <b><sup>2</sup></b> <i>See AUX line related tokens in the \ref Sec_Options section</i> * * \section Sec_PDI PDI Connections * Connections to the device for PDI programming (when enabled): @@ -153,7 +153,7 @@ * </tr> * </table> * - * <b><sup>1</sup></b> <i>Optional, see \ref SSec_Options section - for USB AVRs with ADC modules only</i> \n + * <b><sup>1</sup></b> <i>Optional, see \ref Sec_Options section - for USB AVRs with ADC modules only</i> \n * <b><sup>2</sup></b> <i>The AVR's Tx and Rx become the DATA line when connected together via a pair of 220 ohm resistors</i> \n * * \section Sec_TPI TPI Connections @@ -197,11 +197,11 @@ * </tr> * </table> * - * <b><sup>1</sup></b> <i>Optional, see \ref SSec_Options section - for USB AVRs with ADC modules only</i> \n + * <b><sup>1</sup></b> <i>Optional, see \ref Sec_Options section - for USB AVRs with ADC modules only</i> \n * <b><sup>2</sup></b> <i>The AVR's Tx and Rx become the DATA line when connected together via a pair of 220 ohm resistors</i> \n - * <b><sup>3</sup></b> <i>See AUX line related tokens in the \ref SSec_Options section</i> + * <b><sup>3</sup></b> <i>See AUX line related tokens in the \ref Sec_Options section</i> * - * \section SSec_Options Project Options + * \section Sec_Options Project Options * * The following defines can be found in this project, which can control the project behaviour when defined, or changed in value. * diff --git a/Projects/Benito/Benito.txt b/Projects/Benito/Benito.txt index 60d77cd4a..f1a4f6acd 100644 --- a/Projects/Benito/Benito.txt +++ b/Projects/Benito/Benito.txt @@ -6,7 +6,7 @@ /** \mainpage Benito Arduino Programmer Project * - * \section SSec_Compat Project Compatibility: + * \section Sec_Compat Project Compatibility: * * The following list indicates what microcontrollers are compatible with this project. * @@ -15,7 +15,7 @@ * - Series 4 USB AVRs (ATMEGAxxU4) * - Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2) * - * \section SSec_Info USB Information: + * \section Sec_Info USB Information: * * The following table gives a rundown of the USB utilization of this project. * @@ -43,7 +43,7 @@ * </tr> * </table> * - * \section SSec_Description Project Description: + * \section Sec_Description Project Description: * * Firmware for a USB AVR powered programmer for Arduino boards using the official Arduino bootloader. This * project acts like a regular USB to Serial bridge, except that asserting the DTR line will cause a pulse @@ -56,7 +56,7 @@ * its inbuilt CDC drivers, negating the need for custom drivers for the device. Other Operating Systems should * automatically use their own inbuilt CDC-ACM drivers. * - * \section SSec_Options Project Options + * \section Sec_Options Project Options * * The following defines can be found in this project, which can control the project behaviour when defined, or changed in value. * diff --git a/Projects/LEDNotifier/LEDNotifier.txt b/Projects/LEDNotifier/LEDNotifier.txt index b5eadbabb..9eff23ae8 100644 --- a/Projects/LEDNotifier/LEDNotifier.txt +++ b/Projects/LEDNotifier/LEDNotifier.txt @@ -6,13 +6,13 @@ /** \mainpage USB LED Notifier Project * - * \section SSec_Compat Demo Compatibility: + * \section Sec_Compat Demo Compatibility: * * The following list indicates what microcontrollers are compatible with this demo. * * - AT90USB646 * - * \section SSec_Info USB Information: + * \section Sec_Info USB Information: * * The following table gives a rundown of the USB utilization of this demo. * @@ -39,7 +39,7 @@ * </tr> * </table> * - * \section SSec_Description Project Description: + * \section Sec_Description Project Description: * * USB LED Notifier Project. This project is designed for the Busware BUI board, however it can run easily on any * USB AVR. It is a generic RGB LED controller (via a three channel software PWM) which listens for commands from the @@ -48,7 +48,7 @@ * This can be controlled with any host application that can write to the virtual serial port, allowing it to become * a visual notification system for any number of custom host applications, such as a new unread email notifier. * - * \section SSec_Options Project Options + * \section Sec_Options Project Options * * The following defines can be found in this project, which can control the project behaviour when defined, or changed in value. * diff --git a/Projects/MIDIToneGenerator/MIDIToneGenerator.txt b/Projects/MIDIToneGenerator/MIDIToneGenerator.txt index 447ed7001..05b925906 100644 --- a/Projects/MIDIToneGenerator/MIDIToneGenerator.txt +++ b/Projects/MIDIToneGenerator/MIDIToneGenerator.txt @@ -6,7 +6,7 @@ /** \mainpage MIDI Tone Generator Project
*
- * \section SSec_Compat Project Compatibility:
+ * \section Sec_Compat Project Compatibility:
*
* The following list indicates what microcontrollers are compatible with this project.
*
@@ -14,7 +14,7 @@ * - Series 6 USB AVRs (AT90USBxxx6)
* - Series 4 USB AVRs (ATMEGAxxU4)
*
- * \section SSec_Info USB Information:
+ * \section Sec_Info USB Information:
*
* The following table gives a rundown of the USB utilization of this project.
*
@@ -43,7 +43,7 @@ * </tr>
* </table>
*
- * \section SSec_Description Project Description:
+ * \section Sec_Description Project Description:
*
* MIDI note synthesiser project. This project implements a basic DDS frequency synthesiser, capable of producing 8-bit PWM sine
* waves of variable frequency. When attached to a USB host, this project will allow for multiple MIDI notes to be synthesised into
@@ -52,7 +52,7 @@ * Outgoing audio will output in 8-bit PWM onto the timer 3 output compare channel A. Decouple the audio output with a capacitor
* and attach to a speaker to hear the audio.
*
- * \section SSec_Options Project Options
+ * \section Sec_Options Project Options
*
* The following defines can be found in this project, which can control the project behaviour when defined, or changed in value.
*
diff --git a/Projects/Magstripe/Magstripe.txt b/Projects/Magstripe/Magstripe.txt index 54715b042..9c73c7b67 100644 --- a/Projects/Magstripe/Magstripe.txt +++ b/Projects/Magstripe/Magstripe.txt @@ -6,14 +6,14 @@ /** \mainpage Denver Gingerich's USBSnoop Magnetic Card Reader Project * - * \section SSec_Compat Project Compatibility: + * \section Sec_Compat Project Compatibility: * * The following list indicates what microcontrollers are compatible with this project. * * - AT90USB1287 * - AT90USB1286 * - * \section SSec_Info USB Information: + * \section Sec_Info USB Information: * * The following table gives a rundown of the USB utilization of this project. * @@ -40,7 +40,7 @@ * </tr> * </table> * - * \section SSec_Description Project Description: + * \section Sec_Description Project Description: * * Firmware for a USB AVR powered USB TTL magnetic stripe reader (using a card * reader such as the Omron V3B-4K) by Denver Gingerich. This project is designed @@ -95,7 +95,7 @@ * obtained from the magnetic stripe reader is "typed" through the keyboard * driver as 0's and 1's. After every card swipe, the project will send a return key. * - * \section SSec_Options Project Options + * \section Sec_Options Project Options * * The following defines can be found in this project, which can control the project behaviour when defined, or changed in value. * diff --git a/Projects/MissileLauncher/MissileLauncher.txt b/Projects/MissileLauncher/MissileLauncher.txt index 49918d411..aa7c57213 100644 --- a/Projects/MissileLauncher/MissileLauncher.txt +++ b/Projects/MissileLauncher/MissileLauncher.txt @@ -6,13 +6,13 @@ /** \mainpage David Fletcher's Missile Launcher * - * \section SSec_Compat Project Compatibility: + * \section Sec_Compat Project Compatibility: * * The following list indicates what microcontrollers are compatible with this project. * * - Series 7 USB AVRs (AT90USBxxx7) * - * \section SSec_Info USB Information: + * \section Sec_Info USB Information: * * The following table gives a rundown of the USB utilization of this project. * @@ -39,13 +39,13 @@ * </tr> * </table> * - * \section SSec_Description Project Description: + * \section Sec_Description Project Description: * * Missile Launcher host. This is a host driver for the popular USB-controller table top toy missile launchers, * which can typically aim and fire small foam "missiles" from a spring-loaded turret. This project controls the * launcher via a joystick and button to aim and fire missiles at targets without a PC. * - * \section SSec_Options Project Options + * \section Sec_Options Project Options * * The following defines can be found in this project, which can control the project behaviour when defined, or changed in value. * diff --git a/Projects/RelayBoard/RelayBoard.txt b/Projects/RelayBoard/RelayBoard.txt index 357f780b3..1becfbb9f 100644 --- a/Projects/RelayBoard/RelayBoard.txt +++ b/Projects/RelayBoard/RelayBoard.txt @@ -6,13 +6,13 @@ /** \mainpage OB's Quad-Relay outlet control using a Teensy2++ * - * \section SSec_Compat Project Compatibility: + * \section Sec_Compat Project Compatibility: * * The following list indicates what microcontrollers are compatible with this project. * * - AT90USB1286 * - * \section SSec_Info USB Information: + * \section Sec_Info USB Information: * * The following table gives a rundown of the USB utilization of this project. * @@ -39,7 +39,7 @@ * </tr> * </table> * - * \section SSec_Description Project Description: + * \section Sec_Description Project Description: * * Firmware for a Teensy2++ AVR-based miniboard to control four relays, using the * same protocol used by the commercially available Silver Shield PM power outlets diff --git a/Projects/TempDataLogger/TemperatureDataLogger.txt b/Projects/TempDataLogger/TemperatureDataLogger.txt index 41fb2c320..01a080d87 100644 --- a/Projects/TempDataLogger/TemperatureDataLogger.txt +++ b/Projects/TempDataLogger/TemperatureDataLogger.txt @@ -6,7 +6,7 @@ /** \mainpage Temperature Datalogger Project * - * \section SSec_Compat Demo Compatibility: + * \section Sec_Compat Demo Compatibility: * * The following list indicates what microcontrollers are compatible with this demo. * @@ -14,7 +14,7 @@ * - Series 6 USB AVRs (AT90USBxxx6) * - Series 4 USB AVRs (ATMEGAxxU4) - <i>those with >16KB of FLASH memory only</i> * - * \section SSec_Info USB Information: + * \section Sec_Info USB Information: * * The following table gives a rundown of the USB utilization of this demo. * @@ -47,7 +47,7 @@ * </tr> * </table> * - * \section SSec_Description Project Description: + * \section Sec_Description Project Description: * * Temperature Data Logger project. This project is a very basic USB data logger for the current temperature as reported by * the board's temperature sensor, writing the temperature to a file stored on the board's Dataflash in a FAT filesystem @@ -57,7 +57,7 @@ * * A DS1307 or compatible RTC IC is designed to be attached to the AVR's TWI bus, for the management of timestamps on the * sampled data. This project will not function correctly if the RTC chip is omitted unless the DUMMY_RTC compile time token - * is specified - see \ref SSec_Options. + * is specified - see \ref Sec_Options. * * Due to the host's need for exclusive access to the file system, the device will not log samples while connected to a host. * For the logger to store data, the Dataflash must first be formatted by the host so that it contains a valid FAT file system. @@ -65,7 +65,7 @@ * This project uses the FatFS library from ELM Chan (http://elm-chan.org/fsw/ff/00index_e.html) and the .NET HID device library * LibHIDNet (http://sourceforge.net/projects/libhidnet/). * - * \section SSec_Options Project Options + * \section Sec_Options Project Options * * The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value. * diff --git a/Projects/USBtoSerial/USBtoSerial.txt b/Projects/USBtoSerial/USBtoSerial.txt index 30a2833a5..db65b0e72 100644 --- a/Projects/USBtoSerial/USBtoSerial.txt +++ b/Projects/USBtoSerial/USBtoSerial.txt @@ -6,7 +6,7 @@ /** \mainpage USB to Serial Converter Project * - * \section SSec_Compat Project Compatibility: + * \section Sec_Compat Project Compatibility: * * The following list indicates what microcontrollers are compatible with this project. * @@ -15,7 +15,7 @@ * - Series 4 USB AVRs (ATMEGAxxU4) * - Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2) * - * \section SSec_Info USB Information: + * \section Sec_Info USB Information: * * The following table gives a rundown of the USB utilization of this project. * @@ -42,7 +42,7 @@ * </tr> * </table> * - * \section SSec_Description Project Description: + * \section Sec_Description Project Description: * * USB to Serial bridge project. This project allows a USB AVR to serve * as a USB to USART bridge between a USB host and a device lacking a @@ -63,7 +63,7 @@ * Operating Systems should automatically use their own inbuilt * CDC-ACM drivers. * - * \section SSec_Options Project Options + * \section Sec_Options Project Options * * The following defines can be found in this project, which can control the project behaviour when defined, or changed in value. * diff --git a/Projects/Webserver/Webserver.txt b/Projects/Webserver/Webserver.txt index 3fae431c2..ddb06590a 100644 --- a/Projects/Webserver/Webserver.txt +++ b/Projects/Webserver/Webserver.txt @@ -6,13 +6,13 @@ /** \mainpage uIP Powered Webserver Project * - * \section SSec_Compat Project Compatibility: + * \section Sec_Compat Project Compatibility: * * The following list indicates what microcontrollers are compatible with this project. * * - Series 7 USB AVRs (AT90USBxxx7) * - * \section SSec_Info USB Information: + * \section Sec_Info USB Information: * * The following table gives a rundown of the USB utilization of this project. * @@ -45,7 +45,7 @@ * </tr> * </table> * - * \section SSec_Description Project Description: + * \section Sec_Description Project Description: * * Simple HTTP webserver project. This project combines the LUFA library with the uIP TCP/IP full network stack and FatFS * library to create a RNDIS host capable of serving out HTTP web pages to multiple hosts simultaneously. This project @@ -55,19 +55,19 @@ * To use this project, plug the USB AVR into a computer, so that it enumerates as a standard Mass Storage device. Load * HTML files onto the disk, so that they can be served out to clients -- the default file to serve should be called * <i>index.htm</i>. Filenames must be in 8.3 format for them to be retrieved correctly by the webserver, and the total - * requested file path must be equal to or less than the maximum URI length (\see \ref SSec_Options). + * requested file path must be equal to or less than the maximum URI length (\see \ref Sec_Options). * * When attached to a RNDIS class device, such as a USB (desktop) modem, the system will enumerate the device, set the * appropriate parameters needed for connectivity and begin listening for new HTTP connections on port 80 and TELNET * connections on port 23. The device IP, netmask and default gateway IP must be set to values appropriate for the RNDIS - * device being used for this project to work if the DHCP client is disabled (see \ref SSec_Options) - otherwise, the device + * device being used for this project to work if the DHCP client is disabled (see \ref Sec_Options) - otherwise, the device * will query the network's DHCP server for these parameters automatically. * * When properly configured, the webserver can be accessed from any HTTP web browser by typing in the device's statically or * dynamically allocated IP address. The TELNET client can be accessed via any network socket app by connecting to the device * on port 23 on the device's statically or dynamically allocated IP address. * - * \section SSec_Options Project Options + * \section Sec_Options Project Options * * The following defines can be found in this project, which can control the project behaviour when defined, or changed in value. * diff --git a/Projects/XPLAINBridge/XPLAINBridge.txt b/Projects/XPLAINBridge/XPLAINBridge.txt index 42943101f..353241788 100644 --- a/Projects/XPLAINBridge/XPLAINBridge.txt +++ b/Projects/XPLAINBridge/XPLAINBridge.txt @@ -6,13 +6,13 @@ /** \mainpage XPLAIN UART Bridge/PDI Programmer Project * - * \section SSec_Compat Project Compatibility: + * \section Sec_Compat Project Compatibility: * * The following list indicates what microcontrollers are compatible with this project. * * - AT90USB1287 * - * \section SSec_Info USB Information: + * \section Sec_Info USB Information: * * The following table gives a rundown of the USB utilization of this project. * @@ -44,7 +44,7 @@ * </tr> * </table> * - * \section SSec_Description Project Description: + * \section Sec_Description Project Description: * * This project serves a dual purpose. When loaded into the USB AVR on the XPLAIN board, it will act as either a USB to Serial * converter for the XPLAIN's hardware USART (at a speed of 9600 baud), or an AVRStudio compatible PDI programmer for the XMEGA. @@ -68,7 +68,7 @@ * * This project relies on files from the LUFA AVRISP-MKII project for compilation. * - * \section SSec_Options Project Options + * \section Sec_Options Project Options * * The following defines can be found in this project, which can control the project behaviour when defined, or changed in value. * |