From: Dean Camera Date: Fri, 26 Jun 2009 10:25:59 +0000 (+0000) Subject: Rename some of the library documentation files. X-Git-Tag: LUFA-110528-BETA~1091 X-Git-Url: http://git.linex4red.de/pub/USBasp.git/commitdiff_plain/7366f590f5ab89e954a176eb7cc7fa713ce07d3e Rename some of the library documentation files. --- diff --git a/LUFA.pnproj b/LUFA.pnproj index 7db78da2c..8f6afc54e 100644 --- a/LUFA.pnproj +++ b/LUFA.pnproj @@ -1 +1 @@ - \ No newline at end of file + \ No newline at end of file diff --git a/LUFA/ManPages/DemosBootloadersProjects.txt b/LUFA/ManPages/DemosBootloadersProjects.txt deleted file mode 100644 index 3a6fecc1d..000000000 --- a/LUFA/ManPages/DemosBootloadersProjects.txt +++ /dev/null @@ -1,92 +0,0 @@ -/** \file - * - * This file contains special DoxyGen information for the generation of the main page and other special - * documentation pages. It is not a project source file. - */ - -/** \page Page_LibraryApps Included Library Applications - * - * The LUFA library ships with several different host and device demos, located in the /Demos/ subdirectory. - * If this directory is missing, please re-download the project from the project homepage. Within this directory the demos - * are seperated by USB mode (Device, Host, OTG) and further seperated by the use or non-use of the library USB Class drivers. - * - * Also included with the library are three fully functional bootloaders, located in the /Bootloaders/ subdirectory. - * The DFU class bootloader is compatible with Atmel's FLIP software or the open source dfu-programmer project, the - * CDC class (AVR109 protocol) is compatible with such open source software as AVRDUDE and AVR-OSP, and the TeensyLoader - * HID class bootloader is compatible with the software from PJRC (http://www.pjrc.com/teensy/index.html). - * - * User-submitted projects are located in the /Projects/ subdirectory. If you wish to have your LUFA project included, - * please email it to the Library author. - * - * \section Sec_AppOverview Overview of Included Library Applications - * The following shows the folder structure of the included library applications, including demos, bootloaders and user-submitted - * open source projects. - * - * - * - * - Demos - * - Device - * - ClassDriver - * - AudioInput - Audio In (microphone) demo, using the library USB Audio Class driver framework - * - AudioOutput - Audio Out (speaker) demo, using the library USB Audio Class driver framework - * - CDC - Virtual Serial Port demo, using the library USB CDC Class driver framework - * - DualCDC - Dual Virtual Serial Port demo, using the library USB CDC Class driver framework - * - GenericHID - Generic Human Interface Class demo, using the library USB HID Class driver framework - * - Joystick - USB Joystick demo, using the library USB HID Class driver framework - * - Keyboard - USB Keyboard demo, using the library USB HID Class driver framework - * - KeyboardMouse - Dual Keyboard/Mouse demo, using the library USB HID Class driver framework - * - MassStorage - Dual Drive Mass Storage demo, using the library USB Mass Storage Class driver framework - * - MIDI - MIDI In demo, using the library USB MIDI-Audio Class driver framework - * - Mouse - USB Mouse demo, using the library USB HID driver framework - * - RNDISEthernet - RNDIS Ethernet Webserver demo, using the library USB RNDIS driver framework - * - USBtoSerial - USB to USART Serial converter demo, using the library USB CDC driver framework - * - LowLevel - * - AudioInput - Audio In (microphone) demo, using the low level LUFA APIs to implement the USB Audio class - * - AudioOutput - Audio Out (speaker) demo, using the low level LUFA APIs to implement the USB Audio class - * - CDC - Virtual Serial Port demo, using the low level LUFA APIs to implement the USB CDC class - * - DualCDC - Dual Virtual Serial Port demo, using the low level LUFA APIs to implement the USB CDC class - * - GenericHID - Generic Human Interface Class demo, using the low level LUFA APIs to implement the USB HID class - * - Joystick - USB Joystick demo, using the low level LUFA APIs to implement the USB HID class - * - Keyboard - USB Keyboard demo, using the low level LUFA APIs to implement the USB HID class - * - KeyboardMouse - Dual Keyboard/Mouse demo, using the low level LUFA APIs to implement the USB HID class - * - MassStorage - Dual Drive Mass Storage demo, using the low level LUFA APIs to implement the USB Mass Storage class - * - MIDI - MIDI In demo, using the low level LUFA APIs to implement the USB MIDI-Audio class - * - Mouse - USB Mouse demo, using the low level LUFA APIs to implement the USB HID class - * - RNDISEthernet - RNDIS Ethernet Webserver demo, using the low level LUFA APIs to implement the USB RNDIS class - * - USBtoSerial - USB to USART Serial converter demo, using the low level LUFA APIs to implement the USB CDC class - * - Incomplete - * - SideShow - Incomplete Windows SideShow demo, using the low level LUFA APIs to implement the USB SideShow class - * - Host - * - ClassDriver - * - CDCHost - Virtual Serial Port host demo, using the library USB CDC Class driver framework - * - GenericHIDHost - Generic HID host demo, using the library USB HID Class driver framework - * - KeyboardHost - USB Keyboard host demo, using the library USB HID Class driver framework - * - KeyboardHostWithParser - USB Keyboard host demo with HID Descriptor parser, using the library USB HID Class - * driver framework - * - MassStorageHost - Mass Storage host demo, using the library USB Mass Storage Class driver framework - * - MouseHost - Mouse host demo, using the library USB HID Class driver framework - * - MouseHostWithParser - Mouse host demo with HID Descriptor parser, using the library USB HID Class driver framework - * - StillImageHost - Still Image Camera host demo, using the library USB Still Image Class driver framework - * - LowLevel - * - CDCHost - Virtual Serial Port host demo, using the low level LUFA APIs to implement the USB CDC class - * - GenericHIDHost - Generic HID host demo, using the low level LUFA APIs to implement the USB HID class - * - KeyboardHost - USB Keyboard host demo, using the low level LUFA APIs to implement the USB HID class - * - KeyboardHostWithParser - USB Keyboard host demo with HID Descriptor parser, using the low level LUFA APIs to - * implement the USB HID class - * - MassStorageHost - Mass Storage host demo, using the low level LUFA APIs to implement the USB Mass Storage class - * - MouseHost - Mouse host demo, using the low level LUFA APIs to implement the USB HID class - * - MouseHostWithParser - Mouse host demo with HID Descriptor parser, using the low level LUFA APIs to implement the - * USB HID class - * - StillImageHost - Still Image Camera host demo, using the low level LUFA APIs to implement the USB Still Image class - * - Incomplete - * - BluetoothHost - Incomplete Bluetooth host demo, using the low level LUFA APIs to implement the USB Bluetooth class - * - Bootloaders - * - DFU - DFU Class USB bootloader, compatible with Atmel's FLIP and the open source dfu-programmer software - * - CDC - CDC Class USB bootloader, compatible with any AVR910 protocol programming software such as AVRDude - * - TeensyHID - HID Class bootloader, compatible with the PJRC TeensyLoader software - * - Projects - * - Magstripe - Magnetic Stripe Card Reader project - * - MissileLaucher - Toy Missile Launcher Host project - * - * - */ \ No newline at end of file diff --git a/LUFA/ManPages/LibraryApps.txt b/LUFA/ManPages/LibraryApps.txt new file mode 100644 index 000000000..3a6fecc1d --- /dev/null +++ b/LUFA/ManPages/LibraryApps.txt @@ -0,0 +1,92 @@ +/** \file + * + * This file contains special DoxyGen information for the generation of the main page and other special + * documentation pages. It is not a project source file. + */ + +/** \page Page_LibraryApps Included Library Applications + * + * The LUFA library ships with several different host and device demos, located in the /Demos/ subdirectory. + * If this directory is missing, please re-download the project from the project homepage. Within this directory the demos + * are seperated by USB mode (Device, Host, OTG) and further seperated by the use or non-use of the library USB Class drivers. + * + * Also included with the library are three fully functional bootloaders, located in the /Bootloaders/ subdirectory. + * The DFU class bootloader is compatible with Atmel's FLIP software or the open source dfu-programmer project, the + * CDC class (AVR109 protocol) is compatible with such open source software as AVRDUDE and AVR-OSP, and the TeensyLoader + * HID class bootloader is compatible with the software from PJRC (http://www.pjrc.com/teensy/index.html). + * + * User-submitted projects are located in the /Projects/ subdirectory. If you wish to have your LUFA project included, + * please email it to the Library author. + * + * \section Sec_AppOverview Overview of Included Library Applications + * The following shows the folder structure of the included library applications, including demos, bootloaders and user-submitted + * open source projects. + * + * + * + * - Demos + * - Device + * - ClassDriver + * - AudioInput - Audio In (microphone) demo, using the library USB Audio Class driver framework + * - AudioOutput - Audio Out (speaker) demo, using the library USB Audio Class driver framework + * - CDC - Virtual Serial Port demo, using the library USB CDC Class driver framework + * - DualCDC - Dual Virtual Serial Port demo, using the library USB CDC Class driver framework + * - GenericHID - Generic Human Interface Class demo, using the library USB HID Class driver framework + * - Joystick - USB Joystick demo, using the library USB HID Class driver framework + * - Keyboard - USB Keyboard demo, using the library USB HID Class driver framework + * - KeyboardMouse - Dual Keyboard/Mouse demo, using the library USB HID Class driver framework + * - MassStorage - Dual Drive Mass Storage demo, using the library USB Mass Storage Class driver framework + * - MIDI - MIDI In demo, using the library USB MIDI-Audio Class driver framework + * - Mouse - USB Mouse demo, using the library USB HID driver framework + * - RNDISEthernet - RNDIS Ethernet Webserver demo, using the library USB RNDIS driver framework + * - USBtoSerial - USB to USART Serial converter demo, using the library USB CDC driver framework + * - LowLevel + * - AudioInput - Audio In (microphone) demo, using the low level LUFA APIs to implement the USB Audio class + * - AudioOutput - Audio Out (speaker) demo, using the low level LUFA APIs to implement the USB Audio class + * - CDC - Virtual Serial Port demo, using the low level LUFA APIs to implement the USB CDC class + * - DualCDC - Dual Virtual Serial Port demo, using the low level LUFA APIs to implement the USB CDC class + * - GenericHID - Generic Human Interface Class demo, using the low level LUFA APIs to implement the USB HID class + * - Joystick - USB Joystick demo, using the low level LUFA APIs to implement the USB HID class + * - Keyboard - USB Keyboard demo, using the low level LUFA APIs to implement the USB HID class + * - KeyboardMouse - Dual Keyboard/Mouse demo, using the low level LUFA APIs to implement the USB HID class + * - MassStorage - Dual Drive Mass Storage demo, using the low level LUFA APIs to implement the USB Mass Storage class + * - MIDI - MIDI In demo, using the low level LUFA APIs to implement the USB MIDI-Audio class + * - Mouse - USB Mouse demo, using the low level LUFA APIs to implement the USB HID class + * - RNDISEthernet - RNDIS Ethernet Webserver demo, using the low level LUFA APIs to implement the USB RNDIS class + * - USBtoSerial - USB to USART Serial converter demo, using the low level LUFA APIs to implement the USB CDC class + * - Incomplete + * - SideShow - Incomplete Windows SideShow demo, using the low level LUFA APIs to implement the USB SideShow class + * - Host + * - ClassDriver + * - CDCHost - Virtual Serial Port host demo, using the library USB CDC Class driver framework + * - GenericHIDHost - Generic HID host demo, using the library USB HID Class driver framework + * - KeyboardHost - USB Keyboard host demo, using the library USB HID Class driver framework + * - KeyboardHostWithParser - USB Keyboard host demo with HID Descriptor parser, using the library USB HID Class + * driver framework + * - MassStorageHost - Mass Storage host demo, using the library USB Mass Storage Class driver framework + * - MouseHost - Mouse host demo, using the library USB HID Class driver framework + * - MouseHostWithParser - Mouse host demo with HID Descriptor parser, using the library USB HID Class driver framework + * - StillImageHost - Still Image Camera host demo, using the library USB Still Image Class driver framework + * - LowLevel + * - CDCHost - Virtual Serial Port host demo, using the low level LUFA APIs to implement the USB CDC class + * - GenericHIDHost - Generic HID host demo, using the low level LUFA APIs to implement the USB HID class + * - KeyboardHost - USB Keyboard host demo, using the low level LUFA APIs to implement the USB HID class + * - KeyboardHostWithParser - USB Keyboard host demo with HID Descriptor parser, using the low level LUFA APIs to + * implement the USB HID class + * - MassStorageHost - Mass Storage host demo, using the low level LUFA APIs to implement the USB Mass Storage class + * - MouseHost - Mouse host demo, using the low level LUFA APIs to implement the USB HID class + * - MouseHostWithParser - Mouse host demo with HID Descriptor parser, using the low level LUFA APIs to implement the + * USB HID class + * - StillImageHost - Still Image Camera host demo, using the low level LUFA APIs to implement the USB Still Image class + * - Incomplete + * - BluetoothHost - Incomplete Bluetooth host demo, using the low level LUFA APIs to implement the USB Bluetooth class + * - Bootloaders + * - DFU - DFU Class USB bootloader, compatible with Atmel's FLIP and the open source dfu-programmer software + * - CDC - CDC Class USB bootloader, compatible with any AVR910 protocol programming software such as AVRDude + * - TeensyHID - HID Class bootloader, compatible with the PJRC TeensyLoader software + * - Projects + * - Magstripe - Magnetic Stripe Card Reader project + * - MissileLaucher - Toy Missile Launcher Host project + * + * + */ \ No newline at end of file diff --git a/LUFA/ManPages/Licence.txt b/LUFA/ManPages/Licence.txt new file mode 100644 index 000000000..120e937ae --- /dev/null +++ b/LUFA/ManPages/Licence.txt @@ -0,0 +1,37 @@ +/** \file + * + * This file contains special DoxyGen information for the generation of the main page and other special + * documentation pages. It is not a project source file. + */ + +/** + * \page Page_Licence licence + * + * The LUFA library is currently released under the MIT licence, included below. + * + * 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. + * + * \verbatim + * Permission to use, copy, modify, and distribute this software + * and its documentation for any purpose and without fee is hereby + * granted, provided that the above copyright notice appear in all + * copies and that both that the copyright notice and this + * permission notice and warranty disclaimer appear in supporting + * documentation, and that the name of the author not be used in + * advertising or publicity pertaining to distribution of the + * software without specific, written prior permission. + * + * The author disclaim all warranties with regard to this + * software, including all implied warranties of merchantability + * and fitness. In no event shall the author be liable for any + * special, indirect or consequential damages or any damages + * whatsoever resulting from loss of use, data or profits, whether + * in an action of contract, negligence or other tortious action, + * arising out of or in connection with the use or performance of + * this software. + * \endverbatim + */ diff --git a/LUFA/ManPages/License.txt b/LUFA/ManPages/License.txt deleted file mode 100644 index 120e937ae..000000000 --- a/LUFA/ManPages/License.txt +++ /dev/null @@ -1,37 +0,0 @@ -/** \file - * - * This file contains special DoxyGen information for the generation of the main page and other special - * documentation pages. It is not a project source file. - */ - -/** - * \page Page_Licence licence - * - * The LUFA library is currently released under the MIT licence, included below. - * - * 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. - * - * \verbatim - * Permission to use, copy, modify, and distribute this software - * and its documentation for any purpose and without fee is hereby - * granted, provided that the above copyright notice appear in all - * copies and that both that the copyright notice and this - * permission notice and warranty disclaimer appear in supporting - * documentation, and that the name of the author not be used in - * advertising or publicity pertaining to distribution of the - * software without specific, written prior permission. - * - * The author disclaim all warranties with regard to this - * software, including all implied warranties of merchantability - * and fitness. In no event shall the author be liable for any - * special, indirect or consequential damages or any damages - * whatsoever resulting from loss of use, data or profits, whether - * in an action of contract, negligence or other tortious action, - * arising out of or in connection with the use or performance of - * this software. - * \endverbatim - */