diff options
| author | Joshua Nelson <jyn514@gmail.com> | 2021-07-10 22:06:10 -0400 |
|---|---|---|
| committer | Joshua Nelson <jyn514@gmail.com> | 2021-08-16 05:41:16 +0000 |
| commit | 03df65497e51c8a69e16ab8d4bc7a7d1b3d471dc (patch) | |
| tree | d17b558ebfac6cca775ca5bac84b8b15d7671ec8 /src/doc | |
| parent | 2bd17c1d43bba43412cc2f051323a279d6751e43 (diff) | |
| download | rust-03df65497e51c8a69e16ab8d4bc7a7d1b3d471dc.tar.gz rust-03df65497e51c8a69e16ab8d4bc7a7d1b3d471dc.zip | |
feature gate doc(primitive)
Diffstat (limited to 'src/doc')
| -rw-r--r-- | src/doc/rustdoc/src/the-doc-attribute.md | 6 | ||||
| -rw-r--r-- | src/doc/rustdoc/src/unstable-features.md | 7 |
2 files changed, 7 insertions, 6 deletions
diff --git a/src/doc/rustdoc/src/the-doc-attribute.md b/src/doc/rustdoc/src/the-doc-attribute.md index d192f7d5ce9..b17ea7cd8f5 100644 --- a/src/doc/rustdoc/src/the-doc-attribute.md +++ b/src/doc/rustdoc/src/the-doc-attribute.md @@ -223,9 +223,3 @@ not eagerly inline it as a module unless you add `#[doc(inline)]`. Any item annotated with `#[doc(hidden)]` will not appear in the documentation, unless the `strip-hidden` pass is removed. - -## `#[doc(primitive)]` - -Since primitive types are defined in the compiler, there's no place to attach documentation -attributes. This attribute is used by the standard library to provide a way to generate -documentation for primitive types. diff --git a/src/doc/rustdoc/src/unstable-features.md b/src/doc/rustdoc/src/unstable-features.md index e9b15666bb3..dce98abcf53 100644 --- a/src/doc/rustdoc/src/unstable-features.md +++ b/src/doc/rustdoc/src/unstable-features.md @@ -131,6 +131,13 @@ Book][unstable-masked] and [its tracking issue][issue-masked]. [unstable-masked]: ../unstable-book/language-features/doc-masked.html [issue-masked]: https://github.com/rust-lang/rust/issues/44027 + +## Document primitives + +Since primitive types are defined in the compiler, there's no place to attach documentation +attributes. The `#[doc(primitive)]` attribute is used by the standard library to provide a way to generate +documentation for primitive types, and requires `#![feature(doc_primitive)]` to enable. + ## Unstable command-line arguments These features are enabled by passing a command-line flag to Rustdoc, but the flags in question are |