about summary refs log tree commit diff
path: root/src/libcore
diff options
context:
space:
mode:
authorValentin Brandl <vbrandl@riseup.net>2017-07-15 15:35:03 +0200
committerValentin Brandl <vbrandl@riseup.net>2017-07-15 15:35:03 +0200
commitdb19bf06244d969361b60e780566acdae13b696e (patch)
tree3b82dc8a983ab0b0f41ac02c21cfa8a37597a81f /src/libcore
parentae4803a750cc415a3b8a69a68cec73400a5e27bf (diff)
downloadrust-db19bf06244d969361b60e780566acdae13b696e.tar.gz
rust-db19bf06244d969361b60e780566acdae13b696e.zip
Document default values for primitive types
Diffstat (limited to 'src/libcore')
-rw-r--r--src/libcore/default.rs37
1 files changed, 19 insertions, 18 deletions
diff --git a/src/libcore/default.rs b/src/libcore/default.rs
index 0d7c1672fbc..45ab4f38b05 100644
--- a/src/libcore/default.rs
+++ b/src/libcore/default.rs
@@ -126,32 +126,33 @@ pub trait Default: Sized {
 }
 
 macro_rules! default_impl {
-    ($t:ty, $v:expr) => {
+    ($t:ty, $v:expr, $doc:expr) => {
         #[stable(feature = "rust1", since = "1.0.0")]
         impl Default for $t {
             #[inline]
+            #[doc = $doc]
             fn default() -> $t { $v }
         }
     }
 }
 
-default_impl! { (), () }
-default_impl! { bool, false }
-default_impl! { char, '\x00' }
+default_impl! { (), (), "Defaults to `()`" }
+default_impl! { bool, false, "Defaults to `false`" }
+default_impl! { char, '\x00', "Defaults to `\\x00`" }
 
-default_impl! { usize, 0 }
-default_impl! { u8, 0 }
-default_impl! { u16, 0 }
-default_impl! { u32, 0 }
-default_impl! { u64, 0 }
-default_impl! { u128, 0 }
+default_impl! { usize, 0, "Defaults to `0`" }
+default_impl! { u8, 0, "Defaults to `0`" }
+default_impl! { u16, 0, "Defaults to `0`" }
+default_impl! { u32, 0, "Defaults to `0`" }
+default_impl! { u64, 0, "Defaults to `0`" }
+default_impl! { u128, 0, "Defaults to `0`" }
 
-default_impl! { isize, 0 }
-default_impl! { i8, 0 }
-default_impl! { i16, 0 }
-default_impl! { i32, 0 }
-default_impl! { i64, 0 }
-default_impl! { i128, 0 }
+default_impl! { isize, 0, "Defaults to `0`" }
+default_impl! { i8, 0, "Defaults to `0`" }
+default_impl! { i16, 0, "Defaults to `0`" }
+default_impl! { i32, 0, "Defaults to `0`" }
+default_impl! { i64, 0, "Defaults to `0`" }
+default_impl! { i128, 0, "Defaults to `0`" }
 
-default_impl! { f32, 0.0f32 }
-default_impl! { f64, 0.0f64 }
+default_impl! { f32, 0.0f32, "Defaults to `0.0`" }
+default_impl! { f64, 0.0f64, "Defaults to `0.0`" }