X-Git-Url: http://git.tdb.fi/?a=blobdiff_plain;f=source%2Faction.h;h=a80c7db4ae6865311ed8a21ff0036d95333e4367;hb=7aeaa4ba965f596edad438c02e345a8843f7469a;hp=60d14506853387445b0922bd9eeb560af1c040dd;hpb=59ac0a44d6edf179c01604c6ced744873213f855;p=builder.git

diff --git a/source/action.h b/source/action.h
index 60d1450..a80c7db 100644
--- a/source/action.h
+++ b/source/action.h
@@ -1,3 +1,10 @@
+/* $Id$
+
+This file is part of builder
+Copyright © 2006-2007 Mikko Rasa, Mikkosoft Productions
+Distributed under the LGPL
+*/
+
 #ifndef ACTION_H_
 #define ACTION_H_
 
@@ -6,12 +13,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;