Skip to content

Commit ab2ebb7

Browse files
dirkbehmeojeda
authored andcommitted
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>
1 parent 38559da commit ab2ebb7

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

rust/kernel/types.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -251,7 +251,7 @@ impl<T, F: FnOnce(T)> Drop for ScopeGuard<T, F> {
251251

252252
/// Stores an opaque value.
253253
///
254-
/// `Opaque<T>` is meant to be used with FFI objects that are never interpreted by Rust code.
254+
/// [`Opaque<T>`] is meant to be used with FFI objects that are never interpreted by Rust code.
255255
///
256256
/// It is used to wrap structs from the C side, like for example `Opaque<bindings::mutex>`.
257257
/// 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> {
266266
/// This has to be used for all values that the C side has access to, because it can't be ensured
267267
/// that the C side is adhering to the usual constraints that Rust needs.
268268
///
269-
/// Using `Opaque<T>` allows to continue to use references on the Rust side even for values shared
269+
/// Using [`Opaque<T>`] allows to continue to use references on the Rust side even for values shared
270270
/// with C.
271271
///
272272
/// # Examples

0 commit comments

Comments
 (0)