about summary refs log tree commit diff
path: root/src/libstd/io/mem.rs
diff options
context:
space:
mode:
authorbors <bors@rust-lang.org>2014-02-28 12:06:30 -0800
committerbors <bors@rust-lang.org>2014-02-28 12:06:30 -0800
commit84ebf74ee2f163461cf021b3d415171e8b5ef8be (patch)
tree50445a54a33026b5130e0723bfff9139d2736fb9 /src/libstd/io/mem.rs
parent58ea029db2fd9da6eac85456191481b4cbdb9e58 (diff)
parent311ac8f480917f2dccb98b0dd08342b18208e477 (diff)
auto merge of #12607 : alexcrichton/rust/io++, r=brson
This lowers the #[allow(missing_doc)] directive into some of the lower modules
which are less mature. Most I/O modules now require comprehensive documentation.
Diffstat (limited to 'src/libstd/io/mem.rs')
-rw-r--r--src/libstd/io/mem.rs2
1 files changed, 2 insertions, 0 deletions
diff --git a/src/libstd/io/mem.rs b/src/libstd/io/mem.rs
index 49c37b4520f..862368a8fa2 100644
--- a/src/libstd/io/mem.rs
+++ b/src/libstd/io/mem.rs
@@ -224,6 +224,8 @@ pub struct BufWriter<'a> {
 }
 
 impl<'a> BufWriter<'a> {
+    /// Creates a new `BufWriter` which will wrap the specified buffer. The
+    /// writer initially starts at position 0.
     pub fn new<'a>(buf: &'a mut [u8]) -> BufWriter<'a> {
         BufWriter {
             buf: buf,