Commit 1ab0dc7

committed

Add documentation for doc(attribute = "...") attribute

1 parent a76fc4a commit 1ab0dc7Copy full SHA for 1ab0dc7

File tree

+17

-0

lines changed

+17

-0

lines changed

Lines changed: 17 additions & 0 deletions

Original file line number	Diff line number	Diff line change
@@ -211,6 +211,23 @@ To do so, the `#[doc(keyword = "...")]` attribute is used. Example:
`211`	`211`	`mod empty_mod {}`
`212`	`212`	```
`213`	`213`
	`214`	`+### Document builtin attributes`
	`215`	`+`
	`216`	`+This is for Rust compiler internal use only.`
	`217`	`+`
	`218`	+Rust builtin attributes are documented in the standard library (look for `repr` for example).
	`219`	`+`
	`220`	+To do so, the `#[doc(attribute = "...")]` attribute is used. Example:
	`221`	`+`
	`222`	+```rust
	`223`	`+#![feature(rustdoc_internals)]`
	`224`	`+#![allow(internal_features)]`
	`225`	`+`
	`226`	`+/// Some documentation about the attribute.`
	`227`	`+#[doc(attribute = "repr")]`
	`228`	`+mod empty_mod {}`
	`229`	+```
	`230`	`+`
`214`	`231`	`### Use the Rust logo as the crate logo`
`215`	`232`
`216`	`233`	`This is for official Rust project use only.`

Comments

(0)