diff options
| author | Dirk Behme <dirk.behme@de.bosch.com> | 2025-03-05 06:34:37 +0100 |
|---|---|---|
| committer | Miguel Ojeda <ojeda@kernel.org> | 2025-03-10 15:24:05 +0100 |
| commit | ab2ebb7bc9d9af2f50b0ad54deb65e1d0b01bc70 (patch) | |
| tree | c5b7acac6cb3b7a7b3df380564777251f8ddc22c /rust | |
| parent | 38559da6afb239e271e709588babe7f98195096b (diff) | |
rust: types: add intra-doc links for `Opaque<T>`
We use intra-doc links wherever possible. Thus add a couple missing ones
for `Opaque<T>`.
Signed-off-by: Dirk Behme <dirk.behme@de.bosch.com>
Reviewed-by: Alice Ryhl <aliceryhl@google.com>
Reviewed-by: Fiona Behrens <me@kloenk.dev>
Reviewed-by: Andreas Hindborg <a.hindborg@kernel.org>
Link: https://lore.kernel.org/r/20250305053438.1532397-1-dirk.behme@de.bosch.com
[ Reworded. - Miguel ]
Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
Diffstat (limited to 'rust')
| -rw-r--r-- | rust/kernel/types.rs | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/rust/kernel/types.rs b/rust/kernel/types.rs index 9cb573d39c34..5801eeb69dc5 100644 --- a/rust/kernel/types.rs +++ b/rust/kernel/types.rs @@ -251,7 +251,7 @@ impl<T, F: FnOnce(T)> Drop for ScopeGuard<T, F> { /// Stores an opaque value. /// -/// `Opaque<T>` is meant to be used with FFI objects that are never interpreted by Rust code. +/// [`Opaque<T>`] is meant to be used with FFI objects that are never interpreted by Rust code. /// /// It is used to wrap structs from the C side, like for example `Opaque<bindings::mutex>`. /// It gets rid of all the usual assumptions that Rust has for a value: @@ -266,7 +266,7 @@ impl<T, F: FnOnce(T)> Drop for ScopeGuard<T, F> { /// This has to be used for all values that the C side has access to, because it can't be ensured /// that the C side is adhering to the usual constraints that Rust needs. /// -/// Using `Opaque<T>` allows to continue to use references on the Rust side even for values shared +/// Using [`Opaque<T>`] allows to continue to use references on the Rust side even for values shared /// with C. /// /// # Examples |