diff options
author | Dean Camera <[email protected]> | 2010-08-29 14:07:31 +0000 |
---|---|---|
committer | Dean Camera <[email protected]> | 2010-08-29 14:07:31 +0000 |
commit | 1afe51faa12ad17f6f72d53b492e2720cfbe992f (patch) | |
tree | 874176c00bc6843d058e9db202bd88fe9ba79072 /LUFA/ManPages | |
parent | b3c6599bb7ab8518c3a457579c538c6520e85b01 (diff) | |
download | qmk_firmware-1afe51faa12ad17f6f72d53b492e2720cfbe992f.tar.gz qmk_firmware-1afe51faa12ad17f6f72d53b492e2720cfbe992f.zip |
Fix up documentation - remove obsolete Scheduler Overview page, roll documentation into the documentation for the (deprecated) Simple Scheduler module.
Diffstat (limited to 'LUFA/ManPages')
-rw-r--r-- | LUFA/ManPages/DevelopingWithLUFA.txt | 1 | ||||
-rw-r--r-- | LUFA/ManPages/Donating.txt | 2 | ||||
-rw-r--r-- | LUFA/ManPages/SchedulerOverview.txt | 35 |
3 files changed, 1 insertions, 37 deletions
diff --git a/LUFA/ManPages/DevelopingWithLUFA.txt b/LUFA/ManPages/DevelopingWithLUFA.txt index 8223c9257e..695d36c515 100644 --- a/LUFA/ManPages/DevelopingWithLUFA.txt +++ b/LUFA/ManPages/DevelopingWithLUFA.txt @@ -17,6 +17,5 @@ * \li \subpage Page_BuildLibrary - Building as a Linkable Library * \li \subpage Page_WritingBoardDrivers - How to Write Custom Board Drivers * \li \subpage Page_SoftwareBootloaderStart - How to jump to the bootloader in software - * \li \subpage Page_SchedulerOverview - Overview of the Simple LUFA Scheduler (DEPRECATED) */
\ No newline at end of file diff --git a/LUFA/ManPages/Donating.txt b/LUFA/ManPages/Donating.txt index fff54adcb3..8a4d601ad5 100644 --- a/LUFA/ManPages/Donating.txt +++ b/LUFA/ManPages/Donating.txt @@ -9,7 +9,7 @@ * * \image html Author.jpg "Dean Camera, LUFA Developer" * - * I am a 20 year old University student studying for a double degree in Computer Science and Electronics Engineering. + * I am a 21 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. diff --git a/LUFA/ManPages/SchedulerOverview.txt b/LUFA/ManPages/SchedulerOverview.txt deleted file mode 100644 index b59821fe0b..0000000000 --- a/LUFA/ManPages/SchedulerOverview.txt +++ /dev/null @@ -1,35 +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_SchedulerOverview LUFA Scheduler Overview - * - * <B>THE LUFA SCHEDULER IS NOW DEPRECATED AND WILL BE REMOVED IN A FUTURE RELEASE. EXISTING CODE SHOULD CONVERT - * TO STANDARD LOOPS AS SHOWN IN THE CURRENT LIBRARY DEMOS.</b> - * - * - * The LUFA library comes with a small, basic round-robbin scheduler which allows for small "tasks" to be executed - * continuously in sequence, and enabled/disabled at runtime. Unlike a conventional, complex RTOS scheduler, the - * LUFA scheduler is very simple in design and operation and is essentially a loop conditionally executing a series - * of functions. - * - * Each LUFA scheduler task should be written similar to an ISR; it should execute quickly (so that no one task - * hogs the processor, preventing another from running before some sort of timeout is exceeded). Unlike normal RTOS - * tasks, each LUFA scheduler task is a regular function, and thus must be designed to be called, and designed to - * return to the calling scheduler function repeatedly. Data which must be preserved between task calls should be - * declared as global or (preferably) as a static local variable inside the task. - * - * The scheduler consists of a task list, listing all the tasks which can be executed by the scheduler. Once started, - * each task is then called one after another, unless the task is stopped by another running task or interrupt. - * - * - * If desired, the LUFA scheduler <b>does not need to be used</b> in a LUFA powered application. A more conventional - * approach to application design can be used, or a proper scheduling RTOS inserted in the place of the LUFA scheduler. - * In the case of the former the USB task must be run manually repeatedly to maintain USB communications, and in the - * case of the latter a proper RTOS task must be set up to do the same. - * - * - * For more information on the LUFA scheduler, see the Scheduler.h file documentation. - */ |