rust-lang/rust
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Auto merge of #29593 - ben0x539:reflect-doc-comment, r=steveklabnik

Browse Source 
Rustdoc takes the first paragraph as a summary, so having a huge
paragraph that ends with introducing an example looked somewhat wrong on
the module page.
This commit is contained in:
bors
2015-11-05 16:29:07 +00:00
parent 2509948b3e 4db95e652e
commit 74185aff27
1 changed files with 6 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
src/libcore/marker.rs
View File

@@ -382,11 +382,12 @@ mod impls {
unsafe impl<'a, T: Send + ?Sized> Send for &'a mut T {} unsafe impl<'a, T: Send + ?Sized> Send for &'a mut T {}
} }
/// A marker trait indicates a type that can be reflected over. This /// A marker trait indicates a type that can be reflected over.
/// trait is implemented for all types. Its purpose is to ensure that ///
/// when you write a generic function that will employ reflection, /// This trait is implemented for all types. Its purpose is to ensure
/// that must be reflected (no pun intended) in the generic bounds of /// that when you write a generic function that will employ
/// that function. Here is an example: /// reflection, that must be reflected (no pun intended) in the
/// generic bounds of that function. Here is an example:
/// ///
/// ``` /// ```
/// #![feature(reflect_marker)] /// #![feature(reflect_marker)]