Skip to content

Commit ae9ab7a

Browse files
committed
zephyr: sys: sync: Fix some doc links
Fix a few broken doc links, by filling in full references. Signed-off-by: David Brown <[email protected]>
1 parent 4193cb4 commit ae9ab7a

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

zephyr/src/sys/sync.rs

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,8 @@ impl Semaphore {
6565
/// Take a semaphore.
6666
///
6767
/// Can be called from ISR if called with [`NoWait`].
68+
///
69+
/// [`NoWait`]: crate::time::NoWait
6870
pub fn take<T>(&self, timeout: T) -> Result<()>
6971
where T: Into<Timeout>,
7072
{
@@ -89,6 +91,8 @@ impl Semaphore {
8991
///
9092
/// This resets the count to zero. Any outstanding [`take`] calls will be aborted with
9193
/// `Error(EAGAIN)`.
94+
///
95+
/// [`take`]: Self::take
9296
pub fn reset(&mut self) {
9397
unsafe {
9498
k_sem_reset(self.item)
@@ -108,8 +112,10 @@ impl Semaphore {
108112
/// A static Zephyr `k_sem`.
109113
///
110114
/// This is intended to be used from within the `kobj_define!` macro. It declares a static ksem
111-
/// that will be properly registered with the Zephyr kernel object system. Call [`take`] to get the
112-
/// [`Semaphore`] that is represents.
115+
/// that will be properly registered with the Zephyr kernel object system. Call [`init_once`] to
116+
/// get the [`Semaphore`] that is represents.
117+
///
118+
/// [`init_once`]: StaticKernelObject::init_once
113119
pub type StaticSemaphore = StaticKernelObject<k_sem>;
114120

115121
unsafe impl Sync for StaticSemaphore {}

0 commit comments

Comments
 (0)