about summary refs log tree commit diff
path: root/src
diff options
context:
space:
mode:
authorBrian Anderson <banderson@mozilla.com>2012-01-23 16:40:33 -0800
committerBrian Anderson <banderson@mozilla.com>2012-01-23 16:40:51 -0800
commit4e2d8d8051d96288ed52fdc897008b95cee43458 (patch)
tree72f4daf6863bc1337bdba5addb5d777037ca7403 /src
parentcd9b344f7b5fe93c52ea7cbce83b21d776fd0b8e (diff)
downloadrust-4e2d8d8051d96288ed52fdc897008b95cee43458.tar.gz
rust-4e2d8d8051d96288ed52fdc897008b95cee43458.zip
core: Add crate docs
Diffstat (limited to 'src')
-rw-r--r--src/libcore/core.rc16
1 files changed, 16 insertions, 0 deletions
diff --git a/src/libcore/core.rc b/src/libcore/core.rc
index 9fdba5c469b..4d3384e7149 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;