Fixed USB_RemoteWakeupEnabled flag never being set (the REMOTE WAKEUP Set Feature...

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

diff --git a/LUFA/Scheduler/Scheduler.h b/LUFA/Scheduler/Scheduler.h
index 979156e..0da80bb 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
  *  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
  *\r
  *  For a task to yield it must return, thus each task should have persistent data marked with the static attribute.\r
  *\r


@@ -44,8 +55,8 @@
  *      \r
  *      TASK_LIST\r
  *      {\r
  *      \r
  *      TASK_LIST\r
  *      {\r

- *             { Task: MyTask1, TaskStatus: TASK_RUN, GroupID: 1  },\r
- *             { Task: MyTask2, TaskStatus: TASK_RUN, GroupID: 1  },\r
+ *             { .Task = MyTask1, .TaskStatus = TASK_RUN, .GroupID = 1  },\r
+ *             { .Task = MyTask2, .TaskStatus = TASK_RUN, .GroupID = 1  },\r

  *      }\r
  *\r
  *      int main(void)\r
  *      }\r
  *\r
  *      int main(void)\r


@@ -63,11 +74,6 @@
  *             // Implementation Here\r
  *      }\r
  *  \endcode\r
  *             // 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
  *\r
  *  @{\r
  */\r


@@ -109,12 +115,12 @@
                         *  \code\r
                         *      TASK_LIST\r
                         *      {\r
                         *  \code\r
                         *      TASK_LIST\r
                         *      {\r

-                        *           { Task: MyTask1, TaskStatus: TASK_RUN, GroupID: 1 },\r
+                        *           { .Task = MyTask1, .TaskStatus = TASK_RUN, .GroupID = 1 },\r

                         *           // More task entries here\r
                         *      }\r
                         *  \endcode\r
                         */\r
                         *           // More task entries here\r
                         *      }\r
                         *  \endcode\r
                         */\r

-                       #define TASK_LIST                         extern TaskEntry_t Scheduler_TaskList[]; TaskEntry_t Scheduler_TaskList[] = \r
+                       #define TASK_LIST                         TaskEntry_t Scheduler_TaskList[] = \r

                        \r
                        /** Constant, giving the maximum delay in scheduler ticks which can be stored in a variable of type\r
                         *  SchedulerDelayCounter_t.\r
                        \r
                        /** Constant, giving the maximum delay in scheduler ticks which can be stored in a variable of type\r
                         *  SchedulerDelayCounter_t.\r


@@ -127,16 +133,23 @@
                        /** Task status mode constant, for passing to Scheduler_SetTaskMode() or Scheduler_SetGroupTaskMode(). */\r
                        #define TASK_STOP                         false\r
                        \r
                        /** Task status mode constant, for passing to Scheduler_SetTaskMode() or Scheduler_SetGroupTaskMode(). */\r
                        #define TASK_STOP                         false\r
                        \r

-                       /** Starts the scheduler in its infinite loop, executing running tasks. This should be placed at the end\r
-                        *  of the user application's main() function, as it can never return to the calling function.\r
-                        */\r
-                       #define Scheduler_Start()                 Scheduler_GoSchedule(TOTAL_TASKS);\r
-                       \r
-                       /** Initializes the scheduler so that the scheduler functions can be called before the scheduler itself\r
-                        *  is started. This must be executed before any scheduler function calls other than Scheduler_Start(),\r
-                        *  and can be omitted if no such functions could be called before the scheduler is started.\r
-                        */\r
-                       #define Scheduler_Init()                  Scheduler_InitScheduler(TOTAL_TASKS);\r
+               /* Pseudo-Function Macros: */\r
+                       #if defined(__DOXYGEN__)\r
+                               /** Starts the scheduler in its infinite loop, executing running tasks. This should be placed at the end\r
+                                *  of the user application's main() function, as it can never return to the calling function.\r
+                                */\r
+                               void Scheduler_Start(void);\r
+                               \r
+                               /** Initializes the scheduler so that the scheduler functions can be called before the scheduler itself\r
+                                *  is started. This must be executed before any scheduler function calls other than Scheduler_Start(),\r
+                                *  and can be omitted if no such functions could be called before the scheduler is started.\r
+                                */\r
+                               void Scheduler_Init(void);\r
+                       #else\r
+                               #define Scheduler_Start()                 Scheduler_GoSchedule(TOTAL_TASKS);\r
+                               \r
+                               #define Scheduler_Init()                  Scheduler_InitScheduler(TOTAL_TASKS);\r
+                       #endif\r

 \r
                /* Type Defines: */\r
                        /** Type define for a pointer to a scheduler task. */\r
 \r
                /* Type Defines: */\r
                        /** Type define for a pointer to a scheduler task. */\r