diff options
| author | Noa <coolreader18@gmail.com> | 2024-09-19 16:42:55 -0500 |
|---|---|---|
| committer | Noa <coolreader18@gmail.com> | 2024-09-19 19:16:53 -0500 |
| commit | e91e01509e1e034a71c545d42410d2ea4f7db89e (patch) | |
| tree | 6bc60b174c2ab61dfb047d9b84b1837e92277b8d /src/doc | |
| parent | 749f80ab051aa0b3724b464130440b0e70a975ac (diff) | |
| download | rust-e91e01509e1e034a71c545d42410d2ea4f7db89e.tar.gz rust-e91e01509e1e034a71c545d42410d2ea4f7db89e.zip | |
Add `field@` and `variant@` doc-link disambiguators
Diffstat (limited to 'src/doc')
| -rw-r--r-- | src/doc/rustdoc/src/write-documentation/linking-to-items-by-name.md | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/src/doc/rustdoc/src/write-documentation/linking-to-items-by-name.md b/src/doc/rustdoc/src/write-documentation/linking-to-items-by-name.md index 1a367b8274b..5e785483402 100644 --- a/src/doc/rustdoc/src/write-documentation/linking-to-items-by-name.md +++ b/src/doc/rustdoc/src/write-documentation/linking-to-items-by-name.md @@ -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 `()`, `{}`, |
