schedule, threads: update comments, const's

[c11tester.git] / schedule.h

diff --git a/schedule.h b/schedule.h
index 48fdde1eb08f2f39eae6984f84ce63dbcf7b3cfc..68ef11106d080afddd6857a322e6d254501554a3 100644 (file)
--- a/schedule.h
+++ b/schedule.h
@@ -1,21 +1,33 @@
+/** @file schedule.h
+ *     @brief Thread scheduler.
+ */
+
 #ifndef __SCHEDULE_H__
 #define __SCHEDULE_H__
 
 #include <list>
+#include "mymemory.h"
 
-#include "model.h"
-
+/* Forward declaration */
 class Thread;
 
+/** @brief The Scheduler class performs the mechanics of Thread execution
+ * scheduling. */
 class Scheduler {
 public:
+       Scheduler();
        void add_thread(Thread *t);
        void remove_thread(Thread *t);
-       Thread * next_thread(void);
-       Thread * get_current_thread(void);
+       Thread * next_thread();
+       Thread * get_current_thread() const;
        void print();
+
+       SNAPSHOTALLOC
 private:
+       /** The list of available Threads that are not currently running */
        std::list<Thread *> readyList;
+
+       /** The currently-running Thread */
        Thread *current;
 };