Document a lot of classes and functions

[builder.git] / source / externaltask.h

diff --git a/source/externaltask.h b/source/externaltask.h
index 1b330ff745afd235d31638c87e63ff23adf0bae3..8127c75762459f9a4c73f1c532412a7567c45281 100644 (file)
--- a/source/externaltask.h
+++ b/source/externaltask.h
@@ -7,6 +7,11 @@
 #include <msp/io/pipe.h>
 #include "task.h"
 
+/**
+Runs an external command.  A zero exit status is translated to a SUCCESS status
+for the task, and anything else is treated as an error.  Output can optionally
+be captured.
+*/
 class ExternalTask: public Task
 {
 public:
@@ -30,7 +35,11 @@ private:
        std::string output;
 
 public:
+       /** Creates an ExternalTask with an argument array and an optional working
+       directory.  The first element of the argument array should be the command
+       name.  If the working directory is not specified, no chdir is done. */
        ExternalTask(const Arguments &, const Msp::FS::Path & = Msp::FS::Path());
+
        virtual ~ExternalTask();
 
        virtual std::string get_command() const;