Skip to content

Commit 82ee349

Browse files
committed
zephyr: work: Fix broken doc links
Fix various broken documentation links. Signed-off-by: David Brown <[email protected]>
1 parent d78fd67 commit 82ee349

File tree

4 files changed

+16
-0
lines changed

4 files changed

+16
-0
lines changed

zephyr/src/kio.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,8 @@ impl Future for YieldNow {
127127
/// behavior.
128128
///
129129
/// This could be checked at runtime, but it would have runtime cost.
130+
///
131+
/// [`Forever`]: crate::time::Forever
130132
pub trait ContextExt {
131133
/// Indicate the work should next be scheduled based on a semaphore being available for "take".
132134
///

zephyr/src/sync/channel.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -213,6 +213,8 @@ impl<T: Unpin> Sender<T> {
213213
/// version.
214214
///
215215
/// This has the same behavior as [`send_timeout`], but as an Async function.
216+
///
217+
/// [`send_timeout`]: Sender::send_timeout
216218
pub fn send_timeout_async<'a>(&'a self, msg: T, timeout: impl Into<Timeout>)
217219
-> impl Future<Output = Result<(), SendError<T>>> + 'a
218220
{

zephyr/src/work.rs

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -166,6 +166,14 @@
166166
//! As such, this means that manually constructed work is still built using `Future`. The `_async`
167167
//! primitives throughout this crate can be used just as readily by hand-written Futures as by async
168168
//! code. Notable, the use of [`Signal`] will likely be common, along with possible timeouts.
169+
//!
170+
//! [`sys::sync::Semaphore`]: crate::sys::sync::Semaphore
171+
//! [`sync::channel`]: crate::sync::channel
172+
//! [`sync::Mutex`]: crate::sync::Mutex
173+
//! [`kio::sync::Mutex`]: crate::kio::sync::Mutex
174+
//! [`kio::spawn`]: crate::kio::spawn
175+
//! [`join`]: futures::JoinHandle::join
176+
//! [`join_async`]: futures::JoinHandle::join_async
169177
170178
extern crate alloc;
171179

@@ -408,6 +416,8 @@ impl Signal {
408416
///
409417
/// This reads the status of the signal. If the state is "signalled", this will return
410418
/// `Some(result)` where the `result` is the result value given to [`raise`].
419+
///
420+
/// [`raise`]: Self::raise
411421
pub fn check(&self) -> Option<c_int> {
412422
let mut signaled: c_uint = 0;
413423
let mut result: c_int = 0;

zephyr/src/work/futures.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@
1010
//! time the event is ready. However, work queues expect the work to be queued immediately,
1111
//! with a "poll" indicating what kind of even the work. Work will be scheduled either based on
1212
//! one of these events, or a timeout.
13+
//!
14+
//! [`SimpleAction`]: super::SimpleAction
1315
1416
extern crate alloc;
1517

0 commit comments

Comments
 (0)