Improve primitive integers documentation

This commit is contained in:
Guillaume Gomez
2016-07-07 23:02:10 +02:00
parent 9c1783a3a0
commit a6bbd0c1ca
2 changed files with 62 additions and 0 deletions

View File

@@ -506,6 +506,9 @@ mod prim_f64 { }
///
/// *[See also the `std::i8` module](i8/index.html).*
///
/// However, please note that examples are shared between primitive integer
/// types. So it's normal if you see usage of types like `i64` in there.
///
mod prim_i8 { }
#[doc(primitive = "i16")]
@@ -514,6 +517,9 @@ mod prim_i8 { }
///
/// *[See also the `std::i16` module](i16/index.html).*
///
/// However, please note that examples are shared between primitive integer
/// types. So it's normal if you see usage of types like `i32` in there.
///
mod prim_i16 { }
#[doc(primitive = "i32")]
@@ -522,6 +528,9 @@ mod prim_i16 { }
///
/// *[See also the `std::i32` module](i32/index.html).*
///
/// However, please note that examples are shared between primitive integer
/// types. So it's normal if you see usage of types like `i16` in there.
///
mod prim_i32 { }
#[doc(primitive = "i64")]
@@ -530,6 +539,9 @@ mod prim_i32 { }
///
/// *[See also the `std::i64` module](i64/index.html).*
///
/// However, please note that examples are shared between primitive integer
/// types. So it's normal if you see usage of types like `i8` in there.
///
mod prim_i64 { }
#[doc(primitive = "u8")]
@@ -538,6 +550,9 @@ mod prim_i64 { }
///
/// *[See also the `std::u8` module](u8/index.html).*
///
/// However, please note that examples are shared between primitive integer
/// types. So it's normal if you see usage of types like `u64` in there.
///
mod prim_u8 { }
#[doc(primitive = "u16")]
@@ -546,6 +561,9 @@ mod prim_u8 { }
///
/// *[See also the `std::u16` module](u16/index.html).*
///
/// However, please note that examples are shared between primitive integer
/// types. So it's normal if you see usage of types like `u32` in there.
///
mod prim_u16 { }
#[doc(primitive = "u32")]
@@ -554,6 +572,9 @@ mod prim_u16 { }
///
/// *[See also the `std::u32` module](u32/index.html).*
///
/// However, please note that examples are shared between primitive integer
/// types. So it's normal if you see usage of types like `u16` in there.
///
mod prim_u32 { }
#[doc(primitive = "u64")]
@@ -562,6 +583,9 @@ mod prim_u32 { }
///
/// *[See also the `std::u64` module](u64/index.html).*
///
/// However, please note that examples are shared between primitive integer
/// types. So it's normal if you see usage of types like `u8` in there.
///
mod prim_u64 { }
#[doc(primitive = "isize")]
@@ -570,6 +594,9 @@ mod prim_u64 { }
///
/// *[See also the `std::isize` module](isize/index.html).*
///
/// However, please note that examples are shared between primitive integer
/// types. So it's normal if you see usage of types like `usize` in there.
///
mod prim_isize { }
#[doc(primitive = "usize")]
@@ -578,4 +605,7 @@ mod prim_isize { }
///
/// *[See also the `std::usize` module](usize/index.html).*
///
/// However, please note that examples are shared between primitive integer
/// types. So it's normal if you see usage of types like `isize` in there.
///
mod prim_usize { }