diff options
| author | Jack Huey <31162821+jackh726@users.noreply.github.com> | 2021-09-08 12:24:17 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-09-08 12:24:17 -0400 |
| commit | b1c782f20b99bddf4244d0228fff401e1215f4df (patch) | |
| tree | 72a241bfd6d2c63b096eb748f8aa630f5f98f46e | |
| parent | 77ac329a08b50090c9ac387f3d24ddc46bced92e (diff) | |
| parent | 5135d8692023359f4f04ca627a2571d6b8a0446a (diff) | |
| download | rust-b1c782f20b99bddf4244d0228fff401e1215f4df.tar.gz rust-b1c782f20b99bddf4244d0228fff401e1215f4df.zip | |
Rollup merge of #88594 - steffahn:more_symbolic_doc_aliases, r=joshtriplett
More symbolic doc aliases A bunch of small changes, mostly adding `#[doc(alias = "…")]` entries for symbolic `"…"`. Also a small change in documentation of `const` keywords.
| -rw-r--r-- | library/core/src/ops/bit.rs | 1 | ||||
| -rw-r--r-- | library/std/src/keyword_docs.rs | 2 | ||||
| -rw-r--r-- | library/std/src/primitive_docs.rs | 7 |
3 files changed, 7 insertions, 3 deletions
diff --git a/library/core/src/ops/bit.rs b/library/core/src/ops/bit.rs index 51f80438173..92f45ac9e7e 100644 --- a/library/core/src/ops/bit.rs +++ b/library/core/src/ops/bit.rs @@ -30,6 +30,7 @@ /// ``` #[lang = "not"] #[stable(feature = "rust1", since = "1.0.0")] +#[doc(alias = "!")] pub trait Not { /// The resulting type after applying the `!` operator. #[stable(feature = "rust1", since = "1.0.0")] diff --git a/library/std/src/keyword_docs.rs b/library/std/src/keyword_docs.rs index 749a441d182..3af941f59b6 100644 --- a/library/std/src/keyword_docs.rs +++ b/library/std/src/keyword_docs.rs @@ -119,7 +119,7 @@ mod break_keyword {} #[doc(keyword = "const")] // -/// Compile-time constants and compile-time evaluable functions. +/// Compile-time constants, compile-time evaluable functions, and raw pointers. /// /// ## Compile-time constants /// diff --git a/library/std/src/primitive_docs.rs b/library/std/src/primitive_docs.rs index b85489dabe9..1669c467b91 100644 --- a/library/std/src/primitive_docs.rs +++ b/library/std/src/primitive_docs.rs @@ -388,8 +388,11 @@ mod prim_char {} #[stable(feature = "rust1", since = "1.0.0")] mod prim_unit {} -#[doc(alias = "ptr")] #[doc(primitive = "pointer")] +#[doc(alias = "ptr")] +#[doc(alias = "*")] +#[doc(alias = "*const")] +#[doc(alias = "*mut")] // /// Raw, unsafe pointers, `*const T`, and `*mut T`. /// @@ -502,10 +505,10 @@ mod prim_unit {} #[stable(feature = "rust1", since = "1.0.0")] mod prim_pointer {} +#[doc(primitive = "array")] #[doc(alias = "[]")] #[doc(alias = "[T;N]")] // unfortunately, rustdoc doesn't have fuzzy search for aliases #[doc(alias = "[T; N]")] -#[doc(primitive = "array")] /// A fixed-size array, denoted `[T; N]`, for the element type, `T`, and the /// non-negative compile-time constant size, `N`. /// |