X-Git-Url: http://git.tdb.fi/?a=blobdiff_plain;f=source%2Fexternaltask.h;h=cb8464beab873ef24146b49a5ab02bd6a9aaa21c;hb=71554f76b7ae8f1f9d183dc0c522655ce458cb78;hp=a5f10ec0b0c1486ce6b7b951d8dd10e668923cfb;hpb=666bf60f80a3f220a112c2a97ed00b72871924d3;p=builder.git

diff --git a/source/externaltask.h b/source/externaltask.h
index a5f10ec..cb8464b 100644
--- a/source/externaltask.h
+++ b/source/externaltask.h
@@ -17,9 +17,9 @@ class ExternalTask: public Task
 public:
 	enum Destination
 	{
-		PASSTHROUGH,
-		CAPTURE,
-		IGNORE
+		PASSTHROUGH,  //< Do not touch the stream
+		CAPTURE,      //< Capture the stream
+		IGNORE        //< Redirect the stream to oblivion
 	};
 
 	typedef std::vector<std::string> Arguments;
@@ -45,13 +45,19 @@ public:
 	virtual std::string get_command() const;
 	virtual void start();
 	virtual Status check();
-	Status wait();
+	virtual Status wait();
 private:
 	Status do_wait(bool);
 
 public:
+	/// Sets destination for stdout.  Has no effect after the task is started.
 	void set_stdout(Destination);
+
+	/// Sets destination for stderr.  Has no effect after the task is started.
 	void set_stderr(Destination);
+
+	/** Returns captured output, if any.  This may be called while the task is
+	still running, but it will always return all output. */
 	const std::string &get_output() const { return output; }
 
 	/** Executes a command and captures its output.  Stderr is ignored, but if