rust: list: hide macros from top-level kernel doc
Due to Rust macro scoping rules, all macros defined in a crate using `#[macro_export]` end up in the top-level. For the list macros, we re-export them inside the list module, and expect users to use `kernel::list::macro_name!()`. Use `#[doc(hidden)]` on the macro definition, and use `#[doc(inline)]` on the re-export to make the macro appear to be defined at module-level inside documentation. The other exported types are already automatically `#[doc(inline)]` because they are defined in a non-public module, so there is no need to split the macro re-exports out. Signed-off-by: Gary Guo <gary@garyguo.net> Link: https://patch.msgid.link/20260312174700.4016015-1-gary@kernel.org Signed-off-by: Miguel Ojeda <ojeda@kernel.org>master
parent
9bf32bc60c
commit
d58f0f146a
|
|
@ -12,15 +12,31 @@ use core::ptr;
|
|||
use pin_init::PinInit;
|
||||
|
||||
mod impl_list_item_mod;
|
||||
#[doc(inline)]
|
||||
pub use self::impl_list_item_mod::{
|
||||
impl_has_list_links, impl_has_list_links_self_ptr, impl_list_item, HasListLinks, HasSelfPtr,
|
||||
impl_has_list_links,
|
||||
impl_has_list_links_self_ptr,
|
||||
impl_list_item,
|
||||
HasListLinks,
|
||||
HasSelfPtr, //
|
||||
};
|
||||
|
||||
mod arc;
|
||||
pub use self::arc::{impl_list_arc_safe, AtomicTracker, ListArc, ListArcSafe, TryNewListArc};
|
||||
#[doc(inline)]
|
||||
pub use self::arc::{
|
||||
impl_list_arc_safe,
|
||||
AtomicTracker,
|
||||
ListArc,
|
||||
ListArcSafe,
|
||||
TryNewListArc, //
|
||||
};
|
||||
|
||||
mod arc_field;
|
||||
pub use self::arc_field::{define_list_arc_field_getter, ListArcField};
|
||||
#[doc(inline)]
|
||||
pub use self::arc_field::{
|
||||
define_list_arc_field_getter,
|
||||
ListArcField, //
|
||||
};
|
||||
|
||||
/// A linked list.
|
||||
///
|
||||
|
|
|
|||
|
|
@ -82,6 +82,7 @@ pub unsafe trait TryNewListArc<const ID: u64 = 0>: ListArcSafe<ID> {
|
|||
/// [`AtomicTracker`]. However, it is also possible to defer the tracking to another struct
|
||||
/// using also using this macro.
|
||||
#[macro_export]
|
||||
#[doc(hidden)]
|
||||
macro_rules! impl_list_arc_safe {
|
||||
(impl$({$($generics:tt)*})? ListArcSafe<$num:tt> for $t:ty { untracked; } $($rest:tt)*) => {
|
||||
impl$(<$($generics)*>)? $crate::list::ListArcSafe<$num> for $t {
|
||||
|
|
|
|||
|
|
@ -66,6 +66,7 @@ impl<T, const ID: u64> ListArcField<T, ID> {
|
|||
|
||||
/// Defines getters for a [`ListArcField`].
|
||||
#[macro_export]
|
||||
#[doc(hidden)]
|
||||
macro_rules! define_list_arc_field_getter {
|
||||
($pub:vis fn $name:ident(&self $(<$id:tt>)?) -> &$typ:ty { $field:ident }
|
||||
$($rest:tt)*
|
||||
|
|
|
|||
|
|
@ -29,6 +29,7 @@ pub unsafe trait HasListLinks<const ID: u64 = 0> {
|
|||
|
||||
/// Implements the [`HasListLinks`] trait for the given type.
|
||||
#[macro_export]
|
||||
#[doc(hidden)]
|
||||
macro_rules! impl_has_list_links {
|
||||
($(impl$({$($generics:tt)*})?
|
||||
HasListLinks$(<$id:tt>)?
|
||||
|
|
@ -74,6 +75,7 @@ where
|
|||
|
||||
/// Implements the [`HasListLinks`] and [`HasSelfPtr`] traits for the given type.
|
||||
#[macro_export]
|
||||
#[doc(hidden)]
|
||||
macro_rules! impl_has_list_links_self_ptr {
|
||||
($(impl$({$($generics:tt)*})?
|
||||
HasSelfPtr<$item_type:ty $(, $id:tt)?>
|
||||
|
|
@ -181,6 +183,7 @@ pub use impl_has_list_links_self_ptr;
|
|||
/// }
|
||||
/// ```
|
||||
#[macro_export]
|
||||
#[doc(hidden)]
|
||||
macro_rules! impl_list_item {
|
||||
(
|
||||
$(impl$({$($generics:tt)*})? ListItem<$num:tt> for $self:ty {
|
||||
|
|
|
|||
Loading…
Reference in New Issue