diff options
| author | Alex Crichton <alex@alexcrichton.com> | 2014-05-28 19:53:37 -0700 |
|---|---|---|
| committer | Alex Crichton <alex@alexcrichton.com> | 2014-05-31 21:59:50 -0700 |
| commit | c2e3aa37daedf698072b4aadbc420f24505b2b2d (patch) | |
| tree | 2821fa90613a5e130e2074de7be74740ed541bb1 /src/libstd/num | |
| parent | ba9be0a72bd4aabb67e9b72edd261b2fe449dc86 (diff) | |
| download | rust-c2e3aa37daedf698072b4aadbc420f24505b2b2d.tar.gz rust-c2e3aa37daedf698072b4aadbc420f24505b2b2d.zip | |
rustdoc: Create anchor pages for primitive types
This commit adds support in rustdoc to recognize the `#[doc(primitive = "foo")]` attribute. This attribute indicates that the current module is the "owner" of the primitive type `foo`. For rustdoc, this means that the doc-comment for the module is the doc-comment for the primitive type, plus a signal to all downstream crates that hyperlinks for primitive types will be directed at the crate containing the `#[doc]` directive. Additionally, rustdoc will favor crates closest to the one being documented which "implements the primitive type". For example, documentation of libcore links to libcore for primitive types, but documentation for libstd and beyond all links to libstd for primitive types. This change involves no compiler modifications, it is purely a rustdoc change. The landing pages for the primitive types primarily serve to show a list of implemented traits for the primitive type itself. The primitive types documented includes both strings and slices in a semi-ad-hoc way, but in a way that should provide at least somewhat meaningful documentation. Closes #14474
Diffstat (limited to 'src/libstd/num')
| -rw-r--r-- | src/libstd/num/f32.rs | 1 | ||||
| -rw-r--r-- | src/libstd/num/f64.rs | 1 | ||||
| -rw-r--r-- | src/libstd/num/i16.rs | 2 | ||||
| -rw-r--r-- | src/libstd/num/i32.rs | 2 | ||||
| -rw-r--r-- | src/libstd/num/i64.rs | 2 | ||||
| -rw-r--r-- | src/libstd/num/i8.rs | 2 | ||||
| -rw-r--r-- | src/libstd/num/int.rs | 2 | ||||
| -rw-r--r-- | src/libstd/num/u16.rs | 2 | ||||
| -rw-r--r-- | src/libstd/num/u32.rs | 2 | ||||
| -rw-r--r-- | src/libstd/num/u64.rs | 2 | ||||
| -rw-r--r-- | src/libstd/num/u8.rs | 2 | ||||
| -rw-r--r-- | src/libstd/num/uint.rs | 2 |
12 files changed, 22 insertions, 0 deletions
diff --git a/src/libstd/num/f32.rs b/src/libstd/num/f32.rs index b7bd3705bf2..bbf1458da21 100644 --- a/src/libstd/num/f32.rs +++ b/src/libstd/num/f32.rs @@ -12,6 +12,7 @@ #![allow(missing_doc)] #![allow(unsigned_negate)] +#![doc(primitive = "f32")] use prelude::*; diff --git a/src/libstd/num/f64.rs b/src/libstd/num/f64.rs index e7b29c733ec..cfa8534160b 100644 --- a/src/libstd/num/f64.rs +++ b/src/libstd/num/f64.rs @@ -11,6 +11,7 @@ //! Operations and constants for 64-bits floats (`f64` type) #![allow(missing_doc)] +#![doc(primitive = "f64")] use prelude::*; diff --git a/src/libstd/num/i16.rs b/src/libstd/num/i16.rs index e0c5d93f28a..cfa0662e225 100644 --- a/src/libstd/num/i16.rs +++ b/src/libstd/num/i16.rs @@ -10,6 +10,8 @@ //! Operations and constants for signed 16-bits integers (`i16` type) +#![doc(primitive = "i16")] + use from_str::FromStr; use num::{ToStrRadix, FromStrRadix}; use num::strconv; diff --git a/src/libstd/num/i32.rs b/src/libstd/num/i32.rs index 6938689f47d..3c656b20ee5 100644 --- a/src/libstd/num/i32.rs +++ b/src/libstd/num/i32.rs @@ -10,6 +10,8 @@ //! Operations and constants for signed 32-bits integers (`i32` type) +#![doc(primitive = "i32")] + use from_str::FromStr; use num::{ToStrRadix, FromStrRadix}; use num::strconv; diff --git a/src/libstd/num/i64.rs b/src/libstd/num/i64.rs index 4be43876105..857f78efc9c 100644 --- a/src/libstd/num/i64.rs +++ b/src/libstd/num/i64.rs @@ -10,6 +10,8 @@ //! Operations and constants for signed 64-bits integers (`i64` type) +#![doc(primitive = "i64")] + use from_str::FromStr; use num::{ToStrRadix, FromStrRadix}; use num::strconv; diff --git a/src/libstd/num/i8.rs b/src/libstd/num/i8.rs index b0459ca46f1..a939c1d6b76 100644 --- a/src/libstd/num/i8.rs +++ b/src/libstd/num/i8.rs @@ -10,6 +10,8 @@ //! Operations and constants for signed 8-bits integers (`i8` type) +#![doc(primitive = "i8")] + use from_str::FromStr; use num::{ToStrRadix, FromStrRadix}; use num::strconv; diff --git a/src/libstd/num/int.rs b/src/libstd/num/int.rs index 774b0d7d8cf..415d11b3145 100644 --- a/src/libstd/num/int.rs +++ b/src/libstd/num/int.rs @@ -10,6 +10,8 @@ //! Operations and constants for architecture-sized signed integers (`int` type) +#![doc(primitive = "int")] + use from_str::FromStr; use num::{ToStrRadix, FromStrRadix}; use num::strconv; diff --git a/src/libstd/num/u16.rs b/src/libstd/num/u16.rs index 5200fbd7a3b..3b018414be2 100644 --- a/src/libstd/num/u16.rs +++ b/src/libstd/num/u16.rs @@ -10,6 +10,8 @@ //! Operations and constants for unsigned 16-bits integers (`u16` type) +#![doc(primitive = "u16")] + use from_str::FromStr; use num::{ToStrRadix, FromStrRadix}; use num::strconv; diff --git a/src/libstd/num/u32.rs b/src/libstd/num/u32.rs index 18cdb9e7e87..98012943109 100644 --- a/src/libstd/num/u32.rs +++ b/src/libstd/num/u32.rs @@ -10,6 +10,8 @@ //! Operations and constants for unsigned 32-bits integers (`u32` type) +#![doc(primitive = "u32")] + use from_str::FromStr; use num::{ToStrRadix, FromStrRadix}; use num::strconv; diff --git a/src/libstd/num/u64.rs b/src/libstd/num/u64.rs index 7c17d2cd0bd..b3a8bfc20df 100644 --- a/src/libstd/num/u64.rs +++ b/src/libstd/num/u64.rs @@ -10,6 +10,8 @@ //! Operations and constants for unsigned 64-bits integer (`u64` type) +#![doc(primitive = "u64")] + use from_str::FromStr; use num::{ToStrRadix, FromStrRadix}; use num::strconv; diff --git a/src/libstd/num/u8.rs b/src/libstd/num/u8.rs index 05d86fba40e..d72049d2533 100644 --- a/src/libstd/num/u8.rs +++ b/src/libstd/num/u8.rs @@ -10,6 +10,8 @@ //! Operations and constants for unsigned 8-bits integers (`u8` type) +#![doc(primitive = "u8")] + use from_str::FromStr; use num::{ToStrRadix, FromStrRadix}; use num::strconv; diff --git a/src/libstd/num/uint.rs b/src/libstd/num/uint.rs index ac38f740931..1f43ad8af33 100644 --- a/src/libstd/num/uint.rs +++ b/src/libstd/num/uint.rs @@ -10,6 +10,8 @@ //! Operations and constants for architecture-sized unsigned integers (`uint` type) +#![doc(primitive = "uint")] + use from_str::FromStr; use num::{ToStrRadix, FromStrRadix}; use num::strconv; |
