aboutsummaryrefslogtreecommitdiffstats
path: root/LUFA/ManPages
diff options
context:
space:
mode:
authorDean Camera <dean@fourwalledcubicle.com>2010-03-29 07:49:58 +0000
committerDean Camera <dean@fourwalledcubicle.com>2010-03-29 07:49:58 +0000
commit0557676013f41487701a8951d3dbb4aee3117882 (patch)
treed0c369cd182543f6a2344cb16bafb9be2d985665 /LUFA/ManPages
parentec19436d5456a095f652939c8163a9af2657f391 (diff)
downloadlufa-0557676013f41487701a8951d3dbb4aee3117882.tar.gz
lufa-0557676013f41487701a8951d3dbb4aee3117882.tar.bz2
lufa-0557676013f41487701a8951d3dbb4aee3117882.zip
Add file-level brief documentation.
Remove accidentally duplicated model-specific peripheral driver files.
Diffstat (limited to 'LUFA/ManPages')
-rw-r--r--LUFA/ManPages/AlternativeStacks.txt12
-rw-r--r--LUFA/ManPages/ChangeLog.txt4
-rw-r--r--LUFA/ManPages/FutureChanges.txt1
-rw-r--r--LUFA/ManPages/LibraryApps.txt3
-rw-r--r--LUFA/ManPages/Licence.txt6
-rw-r--r--LUFA/ManPages/MainPage.txt14
6 files changed, 21 insertions, 19 deletions
diff --git a/LUFA/ManPages/AlternativeStacks.txt b/LUFA/ManPages/AlternativeStacks.txt
index ed640f4ab..c7fcfbfc6 100644
--- a/LUFA/ManPages/AlternativeStacks.txt
+++ b/LUFA/ManPages/AlternativeStacks.txt
@@ -7,17 +7,17 @@
/**
* \page Page_AlternativeStacks Alternative USB AVR Stacks
*
- * LUFA is not the only stack available for the USB AVRs, although it is perhaps the best (\see Page_WhyUseLUFA).
+ * LUFA is not the only stack available for the USB AVRs, although it is perhaps the best (see \ref Page_WhyUseLUFA).
* In the interests of completeness and user choice, other known USB AVR stacks are listed here.
*
- * - Atmel USB AVR Stack (<i>Atmel Inc.</i>) \n
+ * - <b>Name:</b> Atmel USB AVR Stack (<i>Atmel Inc.</i>) \n
* <b>Cost:</b> Free \n
* <b>License:</b> Atmel Limited License (see Atmel download for details) \n
* <b>Website:</b> http://atmel.com/dyn/products/app_notes.asp?family_id=607#USB \n
* <b>Description:</b> This is the official Atmel USB AVR stack, for their 8-bit USB AVR lineup. Each series of
* USB AVR is seperated into a seperate download stack, which is both AVR-GCC and IAR compatible.
*
- * - Dr. Stefan Salewski's AT90USB1287 Stack (<i>Dr. Stefan Salewski</i>) \n
+ * - <b>Name:</b> Dr. Stefan Salewski's AT90USB1287 Stack (<i>Dr. Stefan Salewski</i>) \n
* <b>Cost:</b> Free \n
* <b>License:</b> GPL \n
* <b>Website:</b> http://www.ssalewski.de/AT90USB_firmware.html.en \n
@@ -25,13 +25,13 @@
* German Physicist. It compiles for AVR-GCC and can potentially be modified to work on other USB
* AVR models.
*
- * - PJRC Teensy Stack (<i>Paul Stoffregen</i>) \n
+ * - <b>Name:</b> PJRC Teensy Stack (<i>Paul Stoffregen</i>) \n
* <b>Cost:</b> Free \n
* <b>License:</b> BSD \n
* <b>Website:</b> http://www.pjrc.com/teensy/usb_debug_only.html \n
* <b>Description:</b> Not so much a complete stack as a collection of USB enabled demos, this library is specifically
* designed for the PJRC Teensy line of USB AVRs, and thus may need to be modified for other USB AVR
- * chips. These code samples shows the inner workings of the USB controller, without all the abstraction
- * present in most other USB AVR stacks.
+ * chips. These minimal code samples shows the inner workings of the USB controller, without all the
+ * abstraction present in most other USB AVR stacks.
*/
\ No newline at end of file
diff --git a/LUFA/ManPages/ChangeLog.txt b/LUFA/ManPages/ChangeLog.txt
index 1a0fd0d79..07a7134d5 100644
--- a/LUFA/ManPages/ChangeLog.txt
+++ b/LUFA/ManPages/ChangeLog.txt
@@ -14,7 +14,7 @@
* - Added new Relay Controller Board project (thanks to OBinou)
*
* <b>Changed:</b>
- * - AVRISP programmer project now has a more robust timeout system, allowing for an increse of the software USART speed
+ * - AVRISP programmer project now has a more robust timeout system, allowing for an increase of the software USART speed
* for PDI and TPI programming
* - Added a timeout value to the TWI_StartTransmission() function, within which the addressed device must respond
* - Webserver project now uses the board LEDs to indicate the current IP configuration state
@@ -32,7 +32,7 @@
* - Fixed ADC routines not correctly returning the last result when multiple channels were read
* - Fixed ADC routines failing to read the extended channels (Channels 8 to 13, Internal Temperature Sensor) on the
* U4 series USB AVR parts
- * - Fixed LowLevel MassStorage demo broken on the U2 AVRs due to double-banked endpoints
+ * - Fixed LowLevel MassStorage demo broken on the U2 series USB AVRs due to unsupported double-banked endpoint modes used
* - Fixed compilation error in the AudioInput demos when MICROPHONE_BIASED_TO_HALF_RAIL is defined (thanks to C. Scott Ananian)
* - Fixed incorrect definition of HID_ALIGN_DATA() causing incorrect HID report item data alignment
* - Fixed Still Image Host class driver not resetting the transaction ID when a new session is opened, fixed driver not sending
diff --git a/LUFA/ManPages/FutureChanges.txt b/LUFA/ManPages/FutureChanges.txt
index dd5a44287..b0e31e8f7 100644
--- a/LUFA/ManPages/FutureChanges.txt
+++ b/LUFA/ManPages/FutureChanges.txt
@@ -33,6 +33,7 @@
* -# Finish MIDI class Bootloader
* -# Finish SideShow demo
* -# Finish StandaloneProgrammer project
+ * -# Finish MIDIToneGenerator project
* - Ports
* -# AVR32 UC3B series microcontrollers
* -# Atmel ARM7 series microcontrollers
diff --git a/LUFA/ManPages/LibraryApps.txt b/LUFA/ManPages/LibraryApps.txt
index 63e89b947..5f522634d 100644
--- a/LUFA/ManPages/LibraryApps.txt
+++ b/LUFA/ManPages/LibraryApps.txt
@@ -107,6 +107,9 @@
* - <b>USBtoSerial</b> - USB to USART Serial Converter project
* - <b>Webserver</b> - RNDIS Host Webserver with DHCP client, powered by uIP TCP/IP stack project and FatFS library
* - <b>XPLAINBridge</b> - XPLAIN alternative PDI Programmer/USB to Serial Bridge firmware project
+ * - <b>Incomplete</b>
+ * - <b>MIDIToneGenerator</b> - Incomplete MIDI Tone Generator application, to convert MIDI note messages into audio tones
+ * - <b>StandaloneProgrammer</b> - Incomplete Standalone AVR Programmer application, to program AVRs directly from a Mass Storage disk
*
* </small>
*/ \ No newline at end of file
diff --git a/LUFA/ManPages/Licence.txt b/LUFA/ManPages/Licence.txt
index 7f4e1dc27..2160d7960 100644
--- a/LUFA/ManPages/Licence.txt
+++ b/LUFA/ManPages/Licence.txt
@@ -12,9 +12,9 @@
* Commercial entities can opt out of the public disclosure clause in this license
* for a one-time US$1500 payment. This provides a non-exclusive modified MIT licensed which
* allows for the free use of the LUFA library, bootloaders and (where the sole copyright
- * is attributed to Dean Camera) demos without public disclosure within an organisation. Please
- * contact the author for more information (<b>Note: Please do NOT pay this in advance through the
- * donation link shown on \ref Page_Donating - contact author for payment details.</b>).
+ * is attributed to Dean Camera) demos without public disclosure within an organisation, in
+ * addition to three free hours of consultation with the library author, and priority support.
+ * Please contact the author for more information via the address shown on on \ref Page_Resources.
*
* \verbatim
* Permission to use, copy, modify, and distribute this software
diff --git a/LUFA/ManPages/MainPage.txt b/LUFA/ManPages/MainPage.txt
index 30e32e105..d7baa0d65 100644
--- a/LUFA/ManPages/MainPage.txt
+++ b/LUFA/ManPages/MainPage.txt
@@ -7,15 +7,15 @@
/**
* \mainpage
*
- * \n
* \image html LUFA.png
+ * <div align="center"><small><i>Logo design by <b>Ryo Yamauchi</b></i></small></div>
* \n
*
* <b>LUFA is donationware. For author and donation information, see \ref Page_Donating.</b>
*
- * LUFA is an open-source USB library for the USB-enabled AVR microcontrollers, released under the MIT license. It supports
- * a large number of USB AVR models and boards (see \ref Page_DeviceSupport). It is designed to provide an easy to use, feature
- * rich framework for the development of USB peripherals and hosts.
+ * LUFA is an open-source USB library for the USB-enabled AVR microcontrollers, released under the MIT license (see \ref Page_Licence).
+ * It supports a large number of USB AVR models and boards (see \ref Page_DeviceSupport). It is designed to provide an easy to use,
+ * feature rich framework for the development of USB peripherals and hosts.
*
* LUFA focuses on the microcontroller side of USB development only; it includes no host USB driver development facilities. While
* custom USB devices can be made with LUFA, the included demos all use the inbuilt OS drivers for each USB class for simplicity.
@@ -34,12 +34,10 @@
* and open source LUFA powered projects.
*
* <b>Subsections:</b>
- * - \subpage Page_WhyUseLUFA Why Use LUFA?
+ * - \subpage Page_WhyUseLUFA What are the advantages of using LUFA?
* - \subpage Page_LUFAvsAtmelStack How does LUFA compare to the Atmel USB AVR stack?
* - \subpage Page_AlternativeStacks Alternative USB AVR Stacks
- * - \subpage Page_Licence Project licence
+ * - \subpage Page_Licence Project source licence and commercial use information
* - \subpage Page_Donating Donating to support this project
* - \subpage Page_LibraryApps Overview of included Demos, Bootloaders and Projects
- *
- * <small><i>Logo design by <b>Ryo Yamauchi</b></i></small>
*/