Document a lot of classes and functions

[builder.git] / source / internaltask.h

diff --git a/source/internaltask.h b/source/internaltask.h
index 83023d3ad33c63e0826cb4e3359a9cedd3413c66..f29a61d29e8a35b7731340fe9df87a0457a13343 100644 (file)
--- 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: