Skip to content

Commit 90f2d1d

Browse files
committed
Closes #12386. Removed 'pub mod' doc-comments in std::io's mod.rs file. Added summary doc-comments to test.rs, util.rs and stdio.rs.
1 parent 7cc6b5e commit 90f2d1d

File tree

4 files changed

+9
-19
lines changed

4 files changed

+9
-19
lines changed

src/libstd/io/mod.rs

-14
Original file line numberDiff line numberDiff line change
@@ -215,46 +215,32 @@ pub use self::buffered::{BufferedReader, BufferedWriter, BufferedStream,
215215
LineBufferedWriter};
216216
pub use self::comm_adapters::{PortReader, ChanWriter};
217217

218-
/// Various utility functions useful for writing I/O tests
219218
pub mod test;
220219

221-
/// Synchronous, non-blocking filesystem operations.
222220
pub mod fs;
223221

224-
/// Synchronous, in-memory I/O.
225222
pub mod pipe;
226223

227-
/// Child process management.
228224
pub mod process;
229225

230-
/// Synchronous, non-blocking network I/O.
231226
pub mod net;
232227

233-
/// Readers and Writers for memory buffers and strings.
234228
mod mem;
235229

236-
/// Non-blocking access to stdin, stdout, stderr
237230
pub mod stdio;
238231

239-
/// Implementations for Result
240232
mod result;
241233

242-
/// Extension traits
243234
pub mod extensions;
244235

245-
/// Basic Timer
246236
pub mod timer;
247237

248-
/// Buffered I/O wrappers
249238
mod buffered;
250239

251-
/// Signal handling
252240
pub mod signal;
253241

254-
/// Utility implementations of Reader and Writer
255242
pub mod util;
256243

257-
/// Adapatation of Chan/Port types to a Writer/Reader type.
258244
mod comm_adapters;
259245

260246
/// The default buffer size for various I/O operations

src/libstd/io/stdio.rs

+5-5
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,12 @@
88
// option. This file may not be copied, modified, or distributed
99
// except according to those terms.
1010

11-
/*!
11+
/*! Non-blocking access to stdin, stdout, and stderr.
1212
13-
This modules provides bindings to the local event loop's TTY interface, using it
14-
to have synchronous, but non-blocking versions of stdio. These handles can be
15-
inspected for information about terminal dimensions or related information
16-
about the stream or terminal that it is attached to.
13+
This module provides bindings to the local event loop's TTY interface, using it
14+
to offer synchronous but non-blocking versions of stdio. These handles can be
15+
inspected for information about terminal dimensions or for related information
16+
about the stream or terminal to which it is attached.
1717
1818
# Example
1919

src/libstd/io/test.rs

+2
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@
88
// option. This file may not be copied, modified, or distributed
99
// except according to those terms.
1010

11+
/*! Various utility functions useful for writing I/O tests */
12+
1113
#[macro_escape];
1214

1315
use os;

src/libstd/io/util.rs

+2
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@
88
// option. This file may not be copied, modified, or distributed
99
// except according to those terms.
1010

11+
/*! Utility implementations of Reader and Writer */
12+
1113
use prelude::*;
1214
use cmp;
1315
use io;

0 commit comments

Comments
 (0)