]> git.lizzy.rs Git - rust.git/commitdiff
Add doc for fn keyword
authorGuillaume Gomez <guillaume1.gomez@gmail.com>
Fri, 15 Jun 2018 21:23:11 +0000 (23:23 +0200)
committerGuillaume Gomez <guillaume1.gomez@gmail.com>
Fri, 15 Jun 2018 21:23:11 +0000 (23:23 +0200)
src/libstd/keyword_docs.rs [new file with mode: 0644]
src/libstd/lib.rs

diff --git a/src/libstd/keyword_docs.rs b/src/libstd/keyword_docs.rs
new file mode 100644 (file)
index 0000000..01bd3ed
--- /dev/null
@@ -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 { }
index 1bdc1dc2b7cfba810cc0e669bf4c4e15f3b2fd98..a6061e96ae587d3cccc4d43a42a7e27727c38dfc 100644 (file)
@@ -547,3 +547,8 @@ mod coresimd {
 // 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");