X-Git-Url: http://git.tdb.fi/?a=blobdiff_plain;f=source%2Faction.h;h=5877e8947d4667270451298b323a6b64cd4eb03b;hb=74266a6e650f019063cdcd1c9a7bd26d8f99041b;hp=60d14506853387445b0922bd9eeb560af1c040dd;hpb=1a46151c99a406123c4ddfc797a7841baf3e4cc2;p=builder.git

diff --git a/source/action.h b/source/action.h
index 60d1450..5877e89 100644
--- a/source/action.h
+++ b/source/action.h
@@ -6,12 +6,23 @@
 
 class Builder;
 
+/**
+Actions are executed to rebuild targets.
+*/
 class Action
 {
 public:
+	/// Emitted when the action has finished
 	sigc::signal<void> signal_done;
 	
+	/**
+	Checks whether the action is done and emits signal_done if it is.
+
+	@return  0 on successful completion, 1 on error, -1 if the action is still
+	         executing
+	*/
 	virtual int check()=0;
+	
 	virtual ~Action() { }
 protected:
 	Builder &builder;