diff options
| author | bors <bors@rust-lang.org> | 2018-06-16 06:38:16 +0000 |
|---|---|---|
| committer | bors <bors@rust-lang.org> | 2018-06-16 06:38:16 +0000 |
| commit | 01fb32b25fb591b1e721d343841ce18984af6deb (patch) | |
| tree | 9a1fc98e312c50c05bcb534ff6635790d332d14b /src/libstd | |
| parent | 68cee8bb36d8cf0c5fe1e9b7ffa0bf096ac5bd68 (diff) | |
| parent | 1fcce48451b5d4484d29ddf0641d2228ba78fdbd (diff) | |
| download | rust-01fb32b25fb591b1e721d343841ce18984af6deb.tar.gz rust-01fb32b25fb591b1e721d343841ce18984af6deb.zip | |
Auto merge of #51581 - GuillaumeGomez:keyword-doc, r=QuietMisdreavus
Keyword doc Part of #51451. r? @QuietMisdreavus
Diffstat (limited to 'src/libstd')
| -rw-r--r-- | src/libstd/keyword_docs.rs | 28 | ||||
| -rw-r--r-- | src/libstd/lib.rs | 5 |
2 files changed, 33 insertions, 0 deletions
diff --git a/src/libstd/keyword_docs.rs b/src/libstd/keyword_docs.rs new file mode 100644 index 00000000000..01bd3edaee9 --- /dev/null +++ b/src/libstd/keyword_docs.rs @@ -0,0 +1,28 @@ +// Copyright 2015 The Rust Project Developers. See the COPYRIGHT +// file at the top-level directory of this distribution and at +// http://rust-lang.org/COPYRIGHT. +// +// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or +// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license +// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your +// option. This file may not be copied, modified, or distributed +// except according to those terms. + +#[doc(keyword = "fn")] +// +/// The `fn` keyword. +/// +/// The `fn` keyword is used to declare a function. +/// +/// Example: +/// +/// ```rust +/// fn some_function() { +/// // code goes in here +/// } +/// ``` +/// +/// For more information about functions, take a look at the [Rust Book][book]. +/// +/// [book]: https://doc.rust-lang.org/book/second-edition/ch03-03-how-functions-work.html +mod fn_keyword { } diff --git a/src/libstd/lib.rs b/src/libstd/lib.rs index 1bdc1dc2b7c..a6061e96ae5 100644 --- a/src/libstd/lib.rs +++ b/src/libstd/lib.rs @@ -547,3 +547,8 @@ pub use stdsimd::arch; // the rustdoc documentation for primitive types. Using `include!` // because rustdoc only looks for these modules at the crate level. include!("primitive_docs.rs"); + +// Include a number of private modules that exist solely to provide +// the rustdoc documentation for the existing keywords. Using `include!` +// because rustdoc only looks for these modules at the crate level. +include!("keyword_docs.rs"); |
