user0/rust
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add field@ and variant@ doc-link disambiguators

Browse source
This commit is contained in:
Noa 2024-09-19 16:42:55 -05:00
parent 749f80ab05
commit e91e01509e
No known key found for this signature in database
GPG key ID: 7F9F7DB1768C59CF
8 changed files with 138 additions and 66 deletions
Download patch file Download diff file Expand all files Collapse all files

4
src/doc/rustdoc/src/write-documentation/linking-to-items-by-name.md
View file

@ -89,8 +89,8 @@ fn Foo() {}
These prefixes will be stripped when displayed in the documentation, so `[struct@Foo]` will be
rendered as `Foo`. The following prefixes are available: `struct`, `enum`, `trait`, `union`,
`mod`, `module`, `const`, `constant`, `fn`, `function`, `method`, `derive`, `type`, `value`,
`macro`, `prim` or `primitive`.
`mod`, `module`, `const`, `constant`, `fn`, `function`, `field`, `variant`, `method`, `derive`,
`type`, `value`, `macro`, `prim` or `primitive`.
You can also disambiguate for functions by adding `()` after the function name,
or for macros by adding `!` after the macro name. The macro `!` can be followed by `()`, `{}`,