1
Fork 0

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.
This commit is contained in:
Alex Crichton 2013-05-28 16:35:52 -05:00
parent 4a5d887b58
commit 007651cd26
50 changed files with 699 additions and 69 deletions

View file

@ -23,6 +23,7 @@ Similar to a mutable option type, but friendlier.
#[mutable]
#[deriving(Clone, DeepClone, Eq)]
#[allow(missing_doc)]
pub struct Cell<T> {
priv value: Option<T>
}
@ -32,6 +33,7 @@ pub fn Cell<T>(value: T) -> Cell<T> {
Cell { value: Some(value) }
}
/// Creates a new empty cell with no value inside.
pub fn empty_cell<T>() -> Cell<T> {
Cell { value: None }
}