aboutsummaryrefslogtreecommitdiffstats
path: root/LUFA/Scheduler/Scheduler.h
diff options
context:
space:
mode:
authorDean Camera <dean@fourwalledcubicle.com>2009-04-17 05:04:21 +0000
committerDean Camera <dean@fourwalledcubicle.com>2009-04-17 05:04:21 +0000
commitd38fa49cb6cb3804c9bb17601688a62ba466b535 (patch)
tree15e7fc6164e77ceb6e415e9a70a8fd8068880702 /LUFA/Scheduler/Scheduler.h
parent6380d057f8911f5d09bdffff4220aa9602df49e2 (diff)
downloadlufa-d38fa49cb6cb3804c9bb17601688a62ba466b535.tar.gz
lufa-d38fa49cb6cb3804c9bb17601688a62ba466b535.tar.bz2
lufa-d38fa49cb6cb3804c9bb17601688a62ba466b535.zip
More documentation changes for better module-level documentation rather than file-level documentation.
Diffstat (limited to 'LUFA/Scheduler/Scheduler.h')
-rw-r--r--LUFA/Scheduler/Scheduler.h16
1 files changed, 11 insertions, 5 deletions
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.
*
* @{
*/