@@ -27,8 +27,9 @@ use sys_common::{AsInner, AsInnerMut, FromInner, IntoInner};
27
27
/// Representation of a running or exited child process.
28
28
///
29
29
/// This structure is used to represent and manage child processes. A child
30
- /// process is created via the `Command` struct, which configures the spawning
31
- /// process and can itself be constructed using a builder-style interface.
30
+ /// process is created via the [`Command`] struct, which configures the
31
+ /// spawning process and can itself be constructed using a builder-style
32
+ /// interface.
32
33
///
33
34
/// # Examples
34
35
///
@@ -48,13 +49,18 @@ use sys_common::{AsInner, AsInnerMut, FromInner, IntoInner};
48
49
///
49
50
/// # Note
50
51
///
51
- /// Take note that there is no implementation of
52
- /// [`Drop`](../../core/ops/trait.Drop.html) for child processes, so if you
53
- /// do not ensure the `Child` has exited then it will continue to run, even
54
- /// after the `Child` handle to the child process has gone out of scope.
52
+ /// Take note that there is no implementation of [`Drop`] for child processes,
53
+ /// so if you do not ensure the `Child` has exited then it will continue to
54
+ /// run, even after the `Child` handle to the child process has gone out of
55
+ /// scope.
55
56
///
56
- /// Calling `wait` (or other functions that wrap around it) will make the
57
- /// parent process wait until the child has actually exited before continuing.
57
+ /// Calling [`wait`][`wait`] (or other functions that wrap around it) will make
58
+ /// the parent process wait until the child has actually exited before
59
+ /// continuing.
60
+ ///
61
+ /// [`Command`]: struct.Command.html
62
+ /// [`Drop`]: ../../core/ops/trait.Drop.html
63
+ /// [`wait`]: #method.wait
58
64
#[ stable( feature = "process" , since = "1.0.0" ) ]
59
65
pub struct Child {
60
66
handle : imp:: Process ,
@@ -91,7 +97,11 @@ impl IntoInner<imp::Process> for Child {
91
97
fn into_inner ( self ) -> imp:: Process { self . handle }
92
98
}
93
99
94
- /// A handle to a child process's stdin
100
+ /// A handle to a child process's stdin. This struct is used in the [`stdin`]
101
+ /// field on [`Child`].
102
+ ///
103
+ /// [`Child`]: struct.Child.html
104
+ /// [`stdin`]: struct.Child.html#structfield.stdin
95
105
#[ stable( feature = "process" , since = "1.0.0" ) ]
96
106
pub struct ChildStdin {
97
107
inner : AnonPipe
@@ -122,7 +132,11 @@ impl FromInner<AnonPipe> for ChildStdin {
122
132
}
123
133
}
124
134
125
- /// A handle to a child process's stdout
135
+ /// A handle to a child process's stdout. This struct is used in the [`stdout`]
136
+ /// field on [`Child`].
137
+ ///
138
+ /// [`Child`]: struct.Child.html
139
+ /// [`stdout`]: struct.Child.html#structfield.stdout
126
140
#[ stable( feature = "process" , since = "1.0.0" ) ]
127
141
pub struct ChildStdout {
128
142
inner : AnonPipe
@@ -152,7 +166,11 @@ impl FromInner<AnonPipe> for ChildStdout {
152
166
}
153
167
}
154
168
155
- /// A handle to a child process's stderr
169
+ /// A handle to a child process's stderr. This struct is used in the [`stderr`]
170
+ /// field on [`Child`].
171
+ ///
172
+ /// [`Child`]: struct.Child.html
173
+ /// [`stderr`]: struct.Child.html#structfield.stderr
156
174
#[ stable( feature = "process" , since = "1.0.0" ) ]
157
175
pub struct ChildStderr {
158
176
inner : AnonPipe
0 commit comments