Add doc about doc alias feature
This commit is contained in:
parent
48ab422be4
commit
1ed3e77b8a
2 changed files with 39 additions and 0 deletions
|
@ -373,3 +373,19 @@ This is an internal flag intended for the standard library and compiler that app
|
|||
`#[unstable]` attribute to any dependent crate that doesn't have another stability attribute. This
|
||||
allows `rustdoc` to be able to generate documentation for the compiler crates and the standard
|
||||
library, as an equivalent command-line argument is provided to `rustc` when building those crates.
|
||||
|
||||
### `doc_alias` feature
|
||||
|
||||
This feature allows you to add alias(es) to an item when using the `rustdoc` search through the
|
||||
`doc(alias)` attribute. Example:
|
||||
|
||||
```rust,no_run
|
||||
#![feature(doc_alias)]
|
||||
|
||||
#[doc(alias = "x")]
|
||||
#[doc(alias = "big")]
|
||||
pub struct BigX;
|
||||
```
|
||||
|
||||
Then, when looking for it through the `rustdoc` search, if you enter "x" or
|
||||
"big", search will show the `BigX` struct first.
|
||||
|
|
23
src/doc/unstable-book/src/language-features/doc-alias.md
Normal file
23
src/doc/unstable-book/src/language-features/doc-alias.md
Normal file
|
@ -0,0 +1,23 @@
|
|||
# `doc_alias`
|
||||
|
||||
The tracking issue for this feature is: [#50146]
|
||||
|
||||
[#50146]: https://github.com/rust-lang/rust/issues/50146
|
||||
|
||||
------------------------
|
||||
|
||||
You can add alias(es) to an item when using the `rustdoc` search through the
|
||||
`doc(alias)` attribute. Example:
|
||||
|
||||
```rust,no_run
|
||||
#![feature(doc_alias)]
|
||||
|
||||
#[doc(alias = "x")]
|
||||
#[doc(alias = "big")]
|
||||
pub struct BigX;
|
||||
```
|
||||
|
||||
Then, when looking for it through the `rustdoc` search, if you enter "x" or
|
||||
"big", search will show the `BigX` struct first.
|
||||
|
||||
Note that this feature is currently hidden behind the `feature(doc_alias)` gate.
|
Loading…
Add table
Add a link
Reference in a new issue