From 1dd1f95af835be787231b8609163581c761d974a Mon Sep 17 00:00:00 2001 From: Guillaume Gomez Date: Fri, 15 Jun 2018 23:23:11 +0200 Subject: [PATCH] Add doc for fn keyword --- src/libstd/keyword_docs.rs | 28 ++++++++++++++++++++++++++++ src/libstd/lib.rs | 5 +++++ 2 files changed, 33 insertions(+) create mode 100644 src/libstd/keyword_docs.rs 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 or the MIT license +// , 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");