Dean Camera
16 years ago
parent
b61049f722
commit
48b3c9976c
File diff suppressed because one or more lines are too long
@ -0,0 +1,20 @@
|
||||
/** \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_AboutLUFA About LUFA
|
||||
*
|
||||
* This section of the manual contains information about the library as a whole, including its supported targets,
|
||||
* past and planned changes, and links to other projects incorporating LUFA.
|
||||
*
|
||||
* <b>Subsections:</b>
|
||||
* - \subpage Page_DeviceSupport Current Device and Hardware Support
|
||||
* - \subpage Page_Resources LUFA and USB Related Resources
|
||||
* - \subpage Page_ChangeLog Project Changelog
|
||||
* - \subpage Page_FutureChanges Planned Changes to the Library
|
||||
* - \subpage Page_LUFAPoweredProjects Other Projects Using LUFA
|
||||
*/
|
||||
|
||||
@ -0,0 +1,17 @@
|
||||
/** \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_DevelopingWithLUFA Developing With LUFA
|
||||
*
|
||||
* \subpage Page_BuildLibrary
|
||||
* \subpage Page_TokenSummary
|
||||
* \subpage Page_GettingStarted
|
||||
* \subpage Page_Migration
|
||||
* \subpage Page_VIDPID
|
||||
* \subpage Page_WritingBoardDrivers
|
||||
*/
|
||||
|
||||
@ -0,0 +1,21 @@
|
||||
/** \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_DevelopingWithLUFA Developing With LUFA
|
||||
*
|
||||
* This section of the manual contains information on LUFA development, such as Getting Started information,
|
||||
* information on compile-time tuning of the library and other developer-related sections.
|
||||
*
|
||||
* <b>Subsections:</b>
|
||||
* - \subpage Page_GettingStarted Getting Started
|
||||
* - \subpage Page_TokenSummary Summary of Compile Time Tokens
|
||||
* - \subpage Page_Migration Migrating from an Older LUFA Version
|
||||
* - \subpage Page_VIDPID Allocated USB VID and PID Values
|
||||
* - \subpage Page_BuildLibrary Building as a Linkable Library
|
||||
* - \subpage Page_WritingBoardDrivers How to Write Custom Board Drivers
|
||||
*/
|
||||
|
||||
@ -0,0 +1,29 @@
|
||||
/** \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_DeviceSupport Device and Hardware Support
|
||||
*
|
||||
* Currently supported AVR models:
|
||||
* - AT90USB1286 (USB Device Only)
|
||||
* - AT90USB1287 (USB Host and Device)
|
||||
* - AT90USB646 (USB Device Only)
|
||||
* - AT90USB647 (USB Host and Device)
|
||||
* - AT90USB82 (USB Device Only)
|
||||
* - AT90USB162 (USB Device Only)
|
||||
* - ATMEGA16U4 (USB Device Only)
|
||||
* - ATMEGA32U4 (USB Device Only)
|
||||
* - ATMEGA32U6 (USB Device Only)
|
||||
*
|
||||
* Currently supported Atmel boards:
|
||||
* - AT90USBKEY
|
||||
* - STK525
|
||||
* - STK526
|
||||
* - RZUSBSTICK
|
||||
* - ATAVRUSBRF01
|
||||
* - Custom User Boards
|
||||
*/
|
||||
|
||||
@ -0,0 +1,17 @@
|
||||
/** \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_Donating Donating to Support This Project
|
||||
*
|
||||
* I am a 20 year old University student studying for a double degree in Computer Science and Electronics Engineering.
|
||||
* The development and support of this library requires much effort from myself, as I am the sole developer, maintainer
|
||||
* and supporter. Please consider donating a small amount to support this and my future Open Source projects - All
|
||||
* donations are <i>greatly</i> appreciated.
|
||||
*
|
||||
* <b>Donate to this project at http://www.fourwalledcubicle.com </b> via PayPal - Thanks in Advance!
|
||||
*/
|
||||
|
||||
@ -0,0 +1,21 @@
|
||||
/** \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_Resources Library Resources
|
||||
*
|
||||
* Project Homepage: http://www.fourwalledcubicle.com/LUFA.php \n
|
||||
* Development Blog: http://www.fourwalledcubicle.com/blog \n
|
||||
* Discussion Group: http://groups.google.com/group/myusb-support-list \n
|
||||
* SVN Access, Bug Reports and Feature Requests: http://code.google.com/p/lufa-lib/ \n
|
||||
* Author's Website: http://www.fourwalledcubicle.com \n
|
||||
*
|
||||
* WinAVR Website: http://winavr.sourceforge.net \n
|
||||
* avr-libc Website: http://www.nongnu.org/avr-libc/ \n
|
||||
*
|
||||
* USB-IF Website: http://www.usb.org \n
|
||||
*/
|
||||
|
||||
@ -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 License
|
||||
*
|
||||
* 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
|
||||
*/
|
||||
@ -0,0 +1,22 @@
|
||||
|
||||
_ _ _ ___ _
|
||||
| | | | | __/ \
|
||||
| |_| U | _| o | - The Lightweight USB
|
||||
|___|___|_||_n_| Framework for AVRs
|
||||
=========================================
|
||||
Written by Dean Camera
|
||||
http://www.fourwalledcubicle.com
|
||||
=========================================
|
||||
|
||||
|
||||
This package contains the complete LUFA library, demos, user-submitted projects
|
||||
and bootloaders for use with compatible microcontroller models. To get started,
|
||||
you will need to install the "Doxygen" documentation generation tool from
|
||||
www.doxygen.org, and run "make doxygen" from the command line. From there, the
|
||||
generated HTML documentation for the library itself will be avaliable in the
|
||||
LUFA/Documentation/html/ directory. View this documentation in your chosen web
|
||||
browser for further Getting Started information.
|
||||
|
||||
The documentation for the library itself (but not the documentation for the
|
||||
individual demos, projects or bootloaders) is also available as a seperate
|
||||
package from the project webpage for convenience if Doxygen cannot be installed.
|
||||
Loading…
Reference in new issue