Document a lot of classes and functions

[builder.git] / source / internaltask.h

diff --git a/source/internaltask.h b/source/internaltask.h
index ea25ba89eca0816751d8f13687b5e4aa5afeefd8..f29a61d29e8a35b7731340fe9df87a0457a13343 100644 (file)
--- a/source/internaltask.h
+++ b/source/internaltask.h
@@ -4,11 +4,18 @@
 #include <msp/core/thread.h>
 #include "task.h"
 
+/**
+Runs a worker thread.  Tools should derive a thread class from
+InternalTask::Worker.  The worker thread must set its status to either SUCCESS
+or ERROR before terminating.
+*/
 class InternalTask: public Task
 {
 public:
        class Worker: public Msp::Thread
        {
+               friend class InternalTask;
+
        protected:
                Status status;
 
@@ -25,6 +32,8 @@ public:
        InternalTask(Worker *);
        ~InternalTask();
 
+       virtual std::string get_command() const { return "<internal>"; }
+       virtual void start();
        virtual Status check();
 };