rust: types: extend `Opaque` documentation
authorDirk Behme <dirk.behme@de.bosch.com>
Wed, 2 Oct 2024 05:03:01 +0000 (07:03 +0200)
committerMiguel Ojeda <ojeda@kernel.org>
Thu, 24 Oct 2024 16:29:27 +0000 (18:29 +0200)
commit718c4069896cabba5c39b637cbb7205927f16ae0
tree35cf5c4fa61d24c1a60d379a3a7efb3d13e8ed27
parent28e848386b92645f93b9f2fdba5882c3ca7fb3e2
rust: types: extend `Opaque` documentation

Update the `Opaque` documentation and add an example as proposed by
Miguel Ojeda in [1]. The documentation update is mainly taken from
Benno Lossin's description [2].

Cc: Nell Shamrell-Harrington <nells@linux.microsoft.com>
Suggested-by: Miguel Ojeda <ojeda@kernel.org>
Link: https://rust-for-linux.zulipchat.com/#narrow/stream/291565/topic/x/near/467478085
Link: https://rust-for-linux.zulipchat.com/#narrow/stream/291565/topic/x/near/470498289
Co-developed-by: Benno Lossin <benno.lossin@proton.me>
Signed-off-by: Benno Lossin <benno.lossin@proton.me>
Signed-off-by: Dirk Behme <dirk.behme@de.bosch.com>
Link: https://lore.kernel.org/r/20241002050301.1927545-1-dirk.behme@de.bosch.com
[ Used `expect`. Rewrapped docs. Added intra-doc link. Formatted
  example. Reworded to fix tag typo/order. Fixed `&mut` formatting
  as discussed. Added Benno's SOB and CDB as discussed. Shortened
  links. - Miguel ]
Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
rust/kernel/types.rs