X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/1c16ae399a9f924c15d9dec54cacb1320ff0a92f..c20a94a4e84c89debf5e7109482ede708a694a0c:/LUFA/Scheduler/Scheduler.h?ds=sidebyside diff --git a/LUFA/Scheduler/Scheduler.h b/LUFA/Scheduler/Scheduler.h index 904380cd3..0da80bb27 100644 --- a/LUFA/Scheduler/Scheduler.h +++ b/LUFA/Scheduler/Scheduler.h @@ -32,6 +32,17 @@ * * Simple round-robbin cooperative scheduler for use in basic projects where non real-time tasks need * to be executed. Each task is executed in sequence, and can be enabled or disabled individually or as a group. + */ + +/** @defgroup Group_Scheduler Simple Task Scheduler - LUFA/Scheduler/Scheduler.h + * + * \section Sec_Dependencies Module Source Dependencies + * The following files must be built with any user project that uses this module: + * - LUFA/Scheduler/Scheduler.c + * + * \section Module Description + * Simple round-robbin cooperative scheduler for use in basic projects where non real-time tasks need + * to be executed. Each task is executed in sequence, and can be enabled or disabled individually or as a group. * * For a task to yield it must return, thus each task should have persistent data marked with the static attribute. * @@ -44,8 +55,8 @@ * * TASK_LIST * { - * { Task: MyTask1, TaskStatus: TASK_RUN, GroupID: 1 }, - * { Task: MyTask2, TaskStatus: TASK_RUN, GroupID: 1 }, + * { .Task = MyTask1, .TaskStatus = TASK_RUN, .GroupID = 1 }, + * { .Task = MyTask2, .TaskStatus = TASK_RUN, .GroupID = 1 }, * } * * int main(void) @@ -63,11 +74,6 @@ * // Implementation Here * } * \endcode - */ - -/** @defgroup Group_Scheduler Simple Task Scheduler - LUFA/Scheduler/Scheduler.h - * - * Simple round-robbin task scheduler. See Scheduler.h description for more details. * * @{ */ @@ -109,7 +115,7 @@ * \code * TASK_LIST * { - * { Task: MyTask1, TaskStatus: TASK_RUN, GroupID: 1 }, + * { .Task = MyTask1, .TaskStatus = TASK_RUN, .GroupID = 1 }, * // More task entries here * } * \endcode @@ -127,7 +133,7 @@ /** Task status mode constant, for passing to Scheduler_SetTaskMode() or Scheduler_SetGroupTaskMode(). */ #define TASK_STOP false - /* Psuedo-Functions: */ + /* Pseudo-Function Macros: */ #if defined(__DOXYGEN__) /** Starts the scheduler in its infinite loop, executing running tasks. This should be placed at the end * of the user application's main() function, as it can never return to the calling function.