me/qmk_firmware
1
0
Fork 0
forked from mirror/qmk_firmware
Code Pull Requests Activity

Use sub pages in main library documentation to improve readability.

Browse Source
This commit is contained in:
Dean Camera
2009-06-15 11:01:58 +00:00
parent b61049f722
commit 48b3c9976c
14 changed files with 199 additions and 83 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
LUFA/AboutLUFA.txt Normal file
View File

@@ -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
*/

4
LUFA/ChangeLog.txt
View File

@@ -12,8 +12,8 @@
* - Added new class drivers and matching demos to the library for rapid application development
* - Added incomplete device and host mode demos for later enhancement
* - Changed bootloaders to use FLASHEND rather than the existence of RAMPZ to determine if far FLASH pointers are needed
* - Error status LEDs shown when device endpoint configuration fails to complete
* - MIDI device demo no longer blocks if a note change event is sent while the endpoint is not ready
* - Error status LEDs shown when device endpoint configuration fails to complete in all demos and projects
* - Low level API MIDI device demo no longer blocks if a note change event is sent while the endpoint is not ready
* - Fixes to MassStorageHost for better device compatibility (increase command timeout, change MassStore_WaitForDataReceived()
* to only unfreeze and check one data pipe at a time)
* - Internal per-device preprocessing conditions changed to per-device series rather than per controller group for finer-grain

2
LUFA/CompileTimeTokens.txt
View File

@@ -4,7 +4,7 @@
* documentation pages. It is not a project source file.
*/
/** \page TokenSummary Summary of Compile Tokens
/** \page Page_TokenSummary Summary of Compile Tokens
*
* The following lists all the possible tokens which can be defined in a project makefile, and passed to the
* compiler via the -D switch, to alter the LUFA library code. These tokens may alter the library behaviour,

17
LUFA/DevelopingWithLUFA Normal file
View File

@@ -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
*/

21
LUFA/DevelopingWithLUFA.txt Normal file
View File

@@ -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
*/

29
LUFA/DeviceSupport.txt Normal file
View File

@@ -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
*/

17
LUFA/Donating.txt Normal file
View File

@@ -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!
*/

2
LUFA/Doxygen.conf
View File

@@ -25,7 +25,7 @@ DOXYFILE_ENCODING = UTF-8
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
# by quotes) that should identify the project.
PROJECT_NAME = "LUFA Library"
PROJECT_NAME = "LUFA (Formerly MyUSB) Library"
# The PROJECT_NUMBER tag can be used to enter a project or revision number.
# This could be handy for archiving the generated documentation or

21
LUFA/LibraryResources.txt Normal file
View File

@@ -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
*/

37
LUFA/License.txt Normal file
View File

@@ -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
*/

83
LUFA/MainPage.txt
View File

@@ -5,33 +5,12 @@
*/
/**
* \mainpage About the LUFA (Formerly MyUSB) Library
* \mainpage General Information
*
* Lightweight USB Framework for AVRs Library, written by Dean Camera.
* Lightweight USB Framework for AVRs Library, written by Dean Camera.
*
* \section Sec_About About this library
*
* Originally based on the AT90USBKEY from Atmel, it is an open-source, driver for the USB-enabled AVR
* microcontrollers, released under the MIT license.
*
* 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
* Originally based on the AT90USBKEY from Atmel, it is an open-source USB library for the USB-enabled AVR
* microcontrollers, released under the MIT license. It now supports a large number of USB AVR models and boards.
*
* The library is currently in a stable release, suitable for download and incorporation into user projects for
* both host and device modes. For information about the project progression, check out my blog.
@@ -40,50 +19,6 @@
* library API more streamlined and robust. You can download AVR-GCC for free in a convenient windows package,
* from the the WinAVR website.
*
*
* \section Sec_Links Library Links
* 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
*
*
* \section Sec_License 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
*
*
* \section Sec_Demos Demos and Bootloaders
* 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.
@@ -93,11 +28,7 @@
* 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).
*
*
* \section Sec_Donations Donate
* 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. Please consider donating a small amount
* to myself to support this and my future Open Source projects. You can donate any amount via PayPal on my website,
* http://www.fourwalledcubicle.com . All donations are greatly appreciated.
* <b>Subsections:</b>
* - \subpage Page_Licence Project License
* - \subpage Page_Donating Donating to Support this Project
*/