about summary refs log tree commit diff
path: root/src/libstd/to_bytes.rs
diff options
context:
space:
mode:
authorAlex Crichton <alex@alexcrichton.com>2013-05-28 16:35:52 -0500
committerAlex Crichton <alex@alexcrichton.com>2013-05-30 01:02:55 -0500
commit007651cd267ee8af88384d968183a1dee0265919 (patch)
treedac8928949cf8c96c6d546f3a0a4b592f0ab9ee9 /src/libstd/to_bytes.rs
parent4a5d887b58ff9833a968e7a0d28282b915e01de8 (diff)
Require documentation by default for libstd
Adds documentation for various things that I understand.
Adds #[allow(missing_doc)] for lots of things that I don't understand.
Diffstat (limited to 'src/libstd/to_bytes.rs')
-rw-r--r--src/libstd/to_bytes.rs4
1 files changed, 4 insertions, 0 deletions
diff --git a/src/libstd/to_bytes.rs b/src/libstd/to_bytes.rs
index 20b45dfb2cc..77e7583ebe5 100644
--- a/src/libstd/to_bytes.rs
+++ b/src/libstd/to_bytes.rs
@@ -303,7 +303,11 @@ impl<A> IterBytes for *const A {
     }
 }
 
+/// A trait for converting a value to a list of bytes.
 pub trait ToBytes {
+    /// Converts the current value to a list of bytes. This is equivalent to
+    /// invoking iter_bytes on a type and collecting all yielded values in an
+    /// array
     fn to_bytes(&self, lsb0: bool) -> ~[u8];
 }