diff options
| author | Alex Crichton <alex@alexcrichton.com> | 2014-11-26 09:44:33 -0800 |
|---|---|---|
| committer | Alex Crichton <alex@alexcrichton.com> | 2014-11-26 16:49:36 -0800 |
| commit | f40fa8304fea63e04364645260112ddaf91ce70f (patch) | |
| tree | d1809a9e7677512378a32cb89bed64602a789296 /src/libstd/sys/windows | |
| parent | 34b98b306ad23ab895f701de1d009ff026a1d2b1 (diff) | |
| parent | f38e4e6d97bf1691858d007afd36b1f356de4774 (diff) | |
| download | rust-f40fa8304fea63e04364645260112ddaf91ce70f.tar.gz rust-f40fa8304fea63e04364645260112ddaf91ce70f.zip | |
rollup merge of #19288: steveklabnik/doc_style_cleanup
This is considered good convention. This is about half of them in total, I just don't want an impossible to land patch. :smile:
Diffstat (limited to 'src/libstd/sys/windows')
| -rw-r--r-- | src/libstd/sys/windows/process.rs | 30 |
1 files changed, 13 insertions, 17 deletions
diff --git a/src/libstd/sys/windows/process.rs b/src/libstd/sys/windows/process.rs index 7d0151a7b6b..78a8e09dac1 100644 --- a/src/libstd/sys/windows/process.rs +++ b/src/libstd/sys/windows/process.rs @@ -33,13 +33,11 @@ use string::String; pub use sys_common::ProcessConfig; -/** - * A value representing a child process. - * - * The lifetime of this value is linked to the lifetime of the actual - * process - the Process destructor calls self.finish() which waits - * for the process to terminate. - */ +/// A value representing a child process. +/// +/// The lifetime of this value is linked to the lifetime of the actual +/// process - the Process destructor calls self.finish() which waits +/// for the process to terminate. pub struct Process { /// The unique id of the process (this should never be negative). pid: pid_t, @@ -263,16 +261,14 @@ impl Process { } } - /** - * Waits for a process to exit and returns the exit code, failing - * if there is no process with the specified id. - * - * Note that this is private to avoid race conditions on unix where if - * a user calls waitpid(some_process.get_id()) then some_process.finish() - * and some_process.destroy() and some_process.finalize() will then either - * operate on a none-existent process or, even worse, on a newer process - * with the same id. - */ + /// Waits for a process to exit and returns the exit code, failing + /// if there is no process with the specified id. + /// + /// Note that this is private to avoid race conditions on unix where if + /// a user calls waitpid(some_process.get_id()) then some_process.finish() + /// and some_process.destroy() and some_process.finalize() will then either + /// operate on a none-existent process or, even worse, on a newer process + /// with the same id. pub fn wait(&self, deadline: u64) -> IoResult<ProcessExit> { use libc::types::os::arch::extra::DWORD; use libc::consts::os::extra::{ |
