X-Git-Url: http://git.tdb.fi/?a=blobdiff_plain;f=source%2Fexternaltask.h;h=cb8464beab873ef24146b49a5ab02bd6a9aaa21c;hb=c75c89d2425ab0c69e94d45a5d956286838bbc67;hp=19ffe71e8fa4ff985a9c44805d608de351634cd4;hpb=afeb81fb97b8ee4e50a3679707deb17e5b79a74f;p=builder.git

diff --git a/source/externaltask.h b/source/externaltask.h
index 19ffe71..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;
@@ -50,8 +50,14 @@ 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