diff options
author | Evan Martin <martine@danga.com> | 2011-04-29 18:03:03 (GMT) |
---|---|---|
committer | Evan Martin <martine@danga.com> | 2011-04-29 18:04:12 (GMT) |
commit | e3168e1d282d6dcac73f710c5deb575613c335b7 (patch) | |
tree | 82b8a12cf35a756ff9f32d5d708e2973f256deb7 /src/subprocess.h | |
parent | fb7c7827ed22662d7dacc0c7a2dd0d48dc41ee06 (diff) | |
download | Ninja-e3168e1d282d6dcac73f710c5deb575613c335b7.zip Ninja-e3168e1d282d6dcac73f710c5deb575613c335b7.tar.gz Ninja-e3168e1d282d6dcac73f710c5deb575613c335b7.tar.bz2 |
add doxygen-compatibile comments to most classes
Diffstat (limited to 'src/subprocess.h')
-rw-r--r-- | src/subprocess.h | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/src/subprocess.h b/src/subprocess.h index acdb625..a1edb0d 100644 --- a/src/subprocess.h +++ b/src/subprocess.h @@ -20,16 +20,16 @@ #include <queue> using namespace std; -// Subprocess wraps a single async subprocess. It is entirely -// passive: it expects the caller to notify it when its fds are ready -// for reading, as well as call Finish() to reap the child once done() -// is true. +/// Subprocess wraps a single async subprocess. It is entirely +/// passive: it expects the caller to notify it when its fds are ready +/// for reading, as well as call Finish() to reap the child once done() +/// is true. struct Subprocess { Subprocess(); ~Subprocess(); bool Start(const string& command); void OnFDReady(int fd); - // Returns true on successful process exit. + /// Returns true on successful process exit. bool Finish(); bool done() const { @@ -46,9 +46,9 @@ struct Subprocess { pid_t pid_; }; -// SubprocessSet runs a poll() loop around a set of Subprocesses. -// DoWork() waits for any state change in subprocesses; finished_ -// is a queue of subprocesses as they finish. +/// SubprocessSet runs a poll() loop around a set of Subprocesses. +/// DoWork() waits for any state change in subprocesses; finished_ +/// is a queue of subprocesses as they finish. struct SubprocessSet { void Add(Subprocess* subprocess); void DoWork(); |