schedule, threads: update comments, const's

[c11tester.git] / schedule.h

diff --git a/schedule.h b/schedule.h
index 9b34e8287ba1c5dd22a71664eae83850bab5a208..68ef11106d080afddd6857a322e6d254501554a3 100644 (file)
--- a/schedule.h
+++ b/schedule.h
@@ -11,18 +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();
 
        SNAPSHOTALLOC
 private:
+       /** The list of available Threads that are not currently running */
        std::list<Thread *> readyList;
+
+       /** The currently-running Thread */
        Thread *current;
 };