about summary refs log tree commit diff
diff options
context:
space:
mode:
authorGuillaume Gomez <guillaume1.gomez@gmail.com>2018-08-23 23:50:05 +0200
committerGuillaume Gomez <guillaume1.gomez@gmail.com>2018-08-23 23:50:05 +0200
commit61fc7f18c3f3fed492ec117d25e9bcc3c5b52217 (patch)
tree38be06ada4b1b8778f82106dc700d280dd2a121a
parentbf1e461173e3936e4014cc951dfbdd7d9ec9190b (diff)
downloadrust-61fc7f18c3f3fed492ec117d25e9bcc3c5b52217.tar.gz
rust-61fc7f18c3f3fed492ec117d25e9bcc3c5b52217.zip
Add struct keyword doc
-rw-r--r--src/libstd/keyword_docs.rs21
1 files changed, 21 insertions, 0 deletions
diff --git a/src/libstd/keyword_docs.rs b/src/libstd/keyword_docs.rs
index 4f6bda6cfe3..d70cf132b3c 100644
--- a/src/libstd/keyword_docs.rs
+++ b/src/libstd/keyword_docs.rs
@@ -56,3 +56,24 @@ mod fn_keyword { }
 ///
 /// [book]: https://doc.rust-lang.org/book/second-edition/ch03-01-variables-and-mutability.html
 mod let_keyword { }
+
+#[doc(keyword = "struct")]
+//
+/// The `struct` keyword.
+///
+/// The `struct` keyword is used to define a struct type.
+///
+/// Example:
+///
+/// ```
+/// struct Foo {
+///     field1: u32,
+///     field2: String,
+/// }
+/// ```
+///
+/// There are different kinds of structs. For more information, take a look at the
+/// [Rust Book][book].
+///
+/// [book]: https://doc.rust-lang.org/book/second-edition/ch05-01-defining-structs.html
+mod struct_keyword { }