Skip to content

Commit 1dd1f95

Browse files
Add doc for fn keyword
1 parent 24edc41 commit 1dd1f95

File tree

2 files changed

+33
-0
lines changed

2 files changed

+33
-0
lines changed

src/libstd/keyword_docs.rs

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
// Copyright 2015 The Rust Project Developers. See the COPYRIGHT
2+
// file at the top-level directory of this distribution and at
3+
// http://rust-lang.org/COPYRIGHT.
4+
//
5+
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
6+
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
7+
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
8+
// option. This file may not be copied, modified, or distributed
9+
// except according to those terms.
10+
11+
#[doc(keyword = "fn")]
12+
//
13+
/// The `fn` keyword.
14+
///
15+
/// The `fn` keyword is used to declare a function.
16+
///
17+
/// Example:
18+
///
19+
/// ```rust
20+
/// fn some_function() {
21+
/// // code goes in here
22+
/// }
23+
/// ```
24+
///
25+
/// For more information about functions, take a look at the [Rust Book][book].
26+
///
27+
/// [book]: https://doc.rust-lang.org/book/second-edition/ch03-03-how-functions-work.html
28+
mod fn_keyword { }

src/libstd/lib.rs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -547,3 +547,8 @@ pub use stdsimd::arch;
547547
// the rustdoc documentation for primitive types. Using `include!`
548548
// because rustdoc only looks for these modules at the crate level.
549549
include!("primitive_docs.rs");
550+
551+
// Include a number of private modules that exist solely to provide
552+
// the rustdoc documentation for the existing keywords. Using `include!`
553+
// because rustdoc only looks for these modules at the crate level.
554+
include!("keyword_docs.rs");

0 commit comments

Comments
 (0)