X-Git-Url: http://git.tdb.fi/?a=blobdiff_plain;f=source%2Finternaltask.h;h=f29a61d29e8a35b7731340fe9df87a0457a13343;hb=90bc57276bd8d82f4d95558ab7afc702edd4bdd2;hp=83023d3ad33c63e0826cb4e3359a9cedd3413c66;hpb=64cd148dcd762ea368d9a552e982fdff83781ef2;p=builder.git

diff --git a/source/internaltask.h b/source/internaltask.h
index 83023d3..f29a61d 100644
--- a/source/internaltask.h
+++ b/source/internaltask.h
@@ -4,6 +4,11 @@
 #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: