diff options
| author | zslayton <zack.slayton@gmail.com> | 2014-02-23 15:48:26 -0500 |
|---|---|---|
| committer | zslayton <zack.slayton@gmail.com> | 2014-02-23 15:48:26 -0500 |
| commit | 90f2d1d947b5882986e3c2c9e3cda2e959adea0d (patch) | |
| tree | cc71bda199ab4eb5249c7aceaaa77628fc25ca57 /src/libstd/io | |
| parent | 7cc6b5e0a3a2038d66301906f76cdb778304a3bd (diff) | |
| download | rust-90f2d1d947b5882986e3c2c9e3cda2e959adea0d.tar.gz rust-90f2d1d947b5882986e3c2c9e3cda2e959adea0d.zip | |
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.
Diffstat (limited to 'src/libstd/io')
| -rw-r--r-- | src/libstd/io/mod.rs | 14 | ||||
| -rw-r--r-- | src/libstd/io/stdio.rs | 10 | ||||
| -rw-r--r-- | src/libstd/io/test.rs | 2 | ||||
| -rw-r--r-- | src/libstd/io/util.rs | 2 |
4 files changed, 9 insertions, 19 deletions
diff --git a/src/libstd/io/mod.rs b/src/libstd/io/mod.rs index 91a8d599326..8678ee5f00b 100644 --- a/src/libstd/io/mod.rs +++ b/src/libstd/io/mod.rs @@ -215,46 +215,32 @@ pub use self::buffered::{BufferedReader, BufferedWriter, BufferedStream, LineBufferedWriter}; pub use self::comm_adapters::{PortReader, ChanWriter}; -/// Various utility functions useful for writing I/O tests pub mod test; -/// Synchronous, non-blocking filesystem operations. pub mod fs; -/// Synchronous, in-memory I/O. pub mod pipe; -/// Child process management. pub mod process; -/// Synchronous, non-blocking network I/O. pub mod net; -/// Readers and Writers for memory buffers and strings. mod mem; -/// Non-blocking access to stdin, stdout, stderr pub mod stdio; -/// Implementations for Result mod result; -/// Extension traits pub mod extensions; -/// Basic Timer pub mod timer; -/// Buffered I/O wrappers mod buffered; -/// Signal handling pub mod signal; -/// Utility implementations of Reader and Writer pub mod util; -/// Adapatation of Chan/Port types to a Writer/Reader type. mod comm_adapters; /// The default buffer size for various I/O operations diff --git a/src/libstd/io/stdio.rs b/src/libstd/io/stdio.rs index e1f0d87e130..b125fd69c5a 100644 --- a/src/libstd/io/stdio.rs +++ b/src/libstd/io/stdio.rs @@ -8,12 +8,12 @@ // option. This file may not be copied, modified, or distributed // except according to those terms. -/*! +/*! Non-blocking access to stdin, stdout, and stderr. -This modules provides bindings to the local event loop's TTY interface, using it -to have synchronous, but non-blocking versions of stdio. These handles can be -inspected for information about terminal dimensions or related information -about the stream or terminal that it is attached to. +This module provides bindings to the local event loop's TTY interface, using it +to offer synchronous but non-blocking versions of stdio. These handles can be +inspected for information about terminal dimensions or for related information +about the stream or terminal to which it is attached. # Example diff --git a/src/libstd/io/test.rs b/src/libstd/io/test.rs index 04ecb479060..d03e5e75c8e 100644 --- a/src/libstd/io/test.rs +++ b/src/libstd/io/test.rs @@ -8,6 +8,8 @@ // option. This file may not be copied, modified, or distributed // except according to those terms. +/*! Various utility functions useful for writing I/O tests */ + #[macro_escape]; use os; diff --git a/src/libstd/io/util.rs b/src/libstd/io/util.rs index acaffd00665..d6d1de00d86 100644 --- a/src/libstd/io/util.rs +++ b/src/libstd/io/util.rs @@ -8,6 +8,8 @@ // option. This file may not be copied, modified, or distributed // except according to those terms. +/*! Utility implementations of Reader and Writer */ + use prelude::*; use cmp; use io; |
