Add comments

[builder.git] / source / action.h

diff --git a/source/action.h b/source/action.h
index 60d14506853387445b0922bd9eeb560af1c040dd..5877e8947d4667270451298b323a6b64cd4eb03b 100644 (file)
--- 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;