schedule, threads: update comments, const's

[c11tester.git] / schedule.h

diff --git a/schedule.h b/schedule.h
index 8267feec9df32f2b26ae1c32a81d3a36f0affb8f..68ef11106d080afddd6857a322e6d254501554a3 100644 (file)
--- a/schedule.h
+++ b/schedule.h
@@ -1,3 +1,7 @@
+/** @file schedule.h
+ *     @brief Thread scheduler.
+ */
+
 #ifndef __SCHEDULE_H__
 #define __SCHEDULE_H__
 
@@ -7,16 +11,23 @@
 /* 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();
-  MEMALLOC
+
+       SNAPSHOTALLOC
 private:
-       std::list<Thread *, MyAlloc< Thread * > > readyList;
+       /** The list of available Threads that are not currently running */
+       std::list<Thread *> readyList;
+
+       /** The currently-running Thread */
        Thread *current;
 };