[rustc.git] / src / libstd / keyword_docs.rs

// 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 { }
Commit	Line	Data
1a4d82fc	1	// Copyright 2015 The Rust Project Developers. See the COPYRIGHT
223e47cc LB	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
94b46f34 XL	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 { }