From d38fa49cb6cb3804c9bb17601688a62ba466b535 Mon Sep 17 00:00:00 2001 From: Dean Camera Date: Fri, 17 Apr 2009 05:04:21 +0000 Subject: More documentation changes for better module-level documentation rather than file-level documentation. --- LUFA/Scheduler/Scheduler.h | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) (limited to 'LUFA/Scheduler') diff --git a/LUFA/Scheduler/Scheduler.h b/LUFA/Scheduler/Scheduler.h index 904380cd3..38e973672 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. * @@ -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. * * @{ */ -- cgit v1.2.3