Skip to content

Commit a13d68e

Browse files
committed
doc(r3): update the documentation of *Definer according to the new terminology
1 parent 373887d commit a13d68e

File tree

5 files changed

+5
-11
lines changed

5 files changed

+5
-11
lines changed

src/r3/src/hunk.rs

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -95,11 +95,9 @@ impl<T> HunkIniter<T> for ZeroInitTag {
9595
}
9696
}
9797

98-
/// Configuration builder type for [`Hunk`].
98+
/// The definer (static builder) for [`Hunk`].
9999
///
100100
/// `InitTag` is either [`DefaultInitTag`] or [`ZeroInitTag`].
101-
///
102-
/// [`Hunk`]: crate::kernel::Hunk
103101
#[must_use = "must call `finish()` to complete registration"]
104102
pub struct HunkDefiner<System, T: ?Sized, InitTag> {
105103
_phantom: PhantomData<(System, InitTag, T)>,

src/r3/src/kernel/interrupt.rs

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -272,9 +272,7 @@ impl<System: raw::KernelInterruptLine> InterruptLineDefiner<System> {
272272

273273
// ----------------------------------------------------------------------------
274274

275-
/// Configuration builder type for [`InterruptHandler`].
276-
///
277-
/// [`InterruptHandler`]: crate::kernel::InterruptHandler
275+
/// The definer (static builder) for [`InterruptHandler`].
278276
pub struct InterruptHandlerDefiner<System: raw::KernelInterruptLine> {
279277
_phantom: PhantomInvariant<System>,
280278
line: Option<InterruptNum>,

src/r3/src/kernel/mutex.rs

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -406,9 +406,7 @@ impl<System: raw::KernelMutex> Mutex<System> {
406406

407407
// ----------------------------------------------------------------------------
408408

409-
/// Configuration builder type for [`Mutex`].
410-
///
411-
/// [`Mutex`]: crate::kernel::Mutex
409+
/// The definer (static builder) for [`Mutex`][].
412410
#[must_use = "must call `finish()` to complete registration"]
413411
pub struct MutexDefiner<System> {
414412
inner: raw_cfg::MutexDescriptor<System>,

src/r3/src/sync/mutex.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ use crate::{
88
},
99
};
1010

11-
/// Configuration builder type for [`Mutex`].
11+
/// The definer (static builder) for [`Mutex`][].
1212
pub struct Definer<System, T, InitTag> {
1313
mutex: mutex::MutexDefiner<System>,
1414
hunk: HunkDefiner<System, UnsafeCell<T>, InitTag>,

src/r3/src/sync/recursive_mutex.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ use crate::{
99
utils::Init,
1010
};
1111

12-
/// Configuration builder type for [`RecursiveMutex`].
12+
/// The definer (static builder) for [`RecursiveMutex`][].
1313
pub struct Definer<System, T, InitTag> {
1414
mutex: mutex::MutexDefiner<System>,
1515
hunk: HunkDefiner<System, MutexInner<T>, InitTag>,

0 commit comments

Comments
 (0)