From 4e2d8d8051d96288ed52fdc897008b95cee43458 Mon Sep 17 00:00:00 2001 From: Brian Anderson Date: Mon, 23 Jan 2012 16:40:33 -0800 Subject: [PATCH] core: Add crate docs --- src/libcore/core.rc | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/src/libcore/core.rc b/src/libcore/core.rc index 9fdba5c469b0..4d3384e71490 100644 --- a/src/libcore/core.rc +++ b/src/libcore/core.rc @@ -7,6 +7,22 @@ #[license = "MIT"]; #[crate_type = "lib"]; +#[doc( + brief = "The Rust core library", + desc = + "The core library provides functionality that is closely tied to \ + the Rust built-in types and runtime services, or that is used in nearly \ + every non-trivial program.\ + \ + The core library is linked by default to all crates and the contents \ + imported. The effect is as though the user had written the following: \ + \ + > use core; \ + > import core::*; \ + \ + This behavior can be disabled with the `--no-core` compiler flag." +)]; + export box, char, float, bessel, f32, f64, int, str, ptr; export uint, u8, u32, u64, vec, bool; export either, option, result;