diff options
| author | Guillaume Gomez <guillaume1.gomez@gmail.com> | 2020-08-20 13:35:00 +0200 |
|---|---|---|
| committer | Guillaume Gomez <guillaume1.gomez@gmail.com> | 2020-09-14 11:03:47 +0200 |
| commit | d069c7e928ab2ac95e3f524ea4d56de518aa2329 (patch) | |
| tree | a50c7b9e19dbdeafc41845282107c644277ee2f5 /src/doc/rustdoc | |
| parent | b5f55b7e1562286798358730e06b0ba13b4c0ea6 (diff) | |
| download | rust-d069c7e928ab2ac95e3f524ea4d56de518aa2329.tar.gz rust-d069c7e928ab2ac95e3f524ea4d56de518aa2329.zip | |
Stabilize doc_alias feature
Diffstat (limited to 'src/doc/rustdoc')
| -rw-r--r-- | src/doc/rustdoc/src/advanced-features.md | 14 | ||||
| -rw-r--r-- | src/doc/rustdoc/src/unstable-features.md | 16 |
2 files changed, 14 insertions, 16 deletions
diff --git a/src/doc/rustdoc/src/advanced-features.md b/src/doc/rustdoc/src/advanced-features.md index 7c12d23e649..c9a0dff5ab3 100644 --- a/src/doc/rustdoc/src/advanced-features.md +++ b/src/doc/rustdoc/src/advanced-features.md @@ -32,3 +32,17 @@ pub struct UnixToken; Here, the respective tokens can only be used by dependent crates on their respective platforms, but they will both appear in documentation. + +## Add aliases for an item in documentation search + +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 +#[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. diff --git a/src/doc/rustdoc/src/unstable-features.md b/src/doc/rustdoc/src/unstable-features.md index 2f49fc8a415..cd8edbcd1a4 100644 --- a/src/doc/rustdoc/src/unstable-features.md +++ b/src/doc/rustdoc/src/unstable-features.md @@ -207,22 +207,6 @@ issue][issue-include]. [unstable-include]: ../unstable-book/language-features/external-doc.html [issue-include]: https://github.com/rust-lang/rust/issues/44732 -### Add aliases for an item in documentation search - -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. - ## Unstable command-line arguments These features are enabled by passing a command-line flag to Rustdoc, but the flags in question are |
