add some comments

[model-checker.git] / schedule.h

diff --git a/schedule.h b/schedule.h
index 555cbc4ad027896337a0910969089103d875956f..cba4b11a6d597011910ceec3a55324d5edf136f4 100644 (file)
--- a/schedule.h
+++ b/schedule.h
@@ -1,18 +1,28 @@
+/** @file schedule.h
+ *     @brief Thread scheduler.
+ */
+
 #ifndef __SCHEDULE_H__
 #define __SCHEDULE_H__
 
 #include <list>
+#include "mymemory.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);
        void print();
+
+       SNAPSHOTALLOC
 private:
        std::list<Thread *> readyList;
        Thread *current;