More documentation changes for better module-level documentation rather than file...

[pub/lufa.git] / LUFA / Scheduler / Scheduler.h

diff --git a/LUFA/Scheduler/Scheduler.h b/LUFA/Scheduler/Scheduler.h
index 904380c..38e9736 100644 (file)
--- a/LUFA/Scheduler/Scheduler.h
+++ b/LUFA/Scheduler/Scheduler.h
@@ -32,6 +32,17 @@
  *\r
  *  Simple round-robbin cooperative scheduler for use in basic projects where non real-time tasks need\r
  *  to be executed. Each task is executed in sequence, and can be enabled or disabled individually or as a group.\r
+ */\r
+ \r
+/** @defgroup Group_Scheduler Simple Task Scheduler - LUFA/Scheduler/Scheduler.h\r
+ *\r
+ *  \section Sec_Dependencies Module Source Dependencies\r
+ *  The following files must be built with any user project that uses this module:\r
+ *    - LUFA/Scheduler/Scheduler.c\r
+ *\r
+ *  \section Module Description\r
+ *  Simple round-robbin cooperative scheduler for use in basic projects where non real-time tasks need\r
+ *  to be executed. Each task is executed in sequence, and can be enabled or disabled individually or as a group.\r
  *\r
  *  For a task to yield it must return, thus each task should have persistent data marked with the static attribute.\r
  *\r
@@ -63,11 +74,6 @@
  *             // Implementation Here\r
  *      }\r
  *  \endcode\r
- */\r
- \r
-/** @defgroup Group_Scheduler Simple Task Scheduler - LUFA/Scheduler/Scheduler.h\r
- *\r
- *  Simple round-robbin task scheduler. See Scheduler.h description for more details.\r
  *\r
  *  @{\r
  */\r