itsscb/embassy
1
0
Fork 0
mirror of https://github.com/embassy-rs/embassy.git synced 2025-10-02 14:44:32 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix some intra-doc links

Browse Source
This commit is contained in:
James Munns 2025-04-03 10:35:00 +02:00
parent 45c4f0cb05
commit b7e1b1ca94
2 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
embassy-executor/src/arch/cortex_m.rs
View File

@ -143,7 +143,7 @@ mod interrupt {
/// If this is not the case, you may use an interrupt from any unused peripheral. /// If this is not the case, you may use an interrupt from any unused peripheral.
/// ///
/// It is somewhat more complex to use, it's recommended to use the thread-mode /// It is somewhat more complex to use, it's recommended to use the thread-mode
/// [`Executor`] instead, if it works for your use case. /// [`Executor`](crate::Executor) instead, if it works for your use case.
pub struct InterruptExecutor { pub struct InterruptExecutor {
started: Mutex<Cell<bool>>, started: Mutex<Cell<bool>>,
executor: UnsafeCell<MaybeUninit<raw::Executor>>, executor: UnsafeCell<MaybeUninit<raw::Executor>>,
@ -179,11 +179,11 @@ mod interrupt {
/// The executor keeps running in the background through the interrupt. /// The executor keeps running in the background through the interrupt.
/// ///
/// This returns a [`SendSpawner`] you can use to spawn tasks on it. A [`SendSpawner`] /// This returns a [`SendSpawner`] you can use to spawn tasks on it. A [`SendSpawner`]
/// is returned instead of a [`Spawner`](embassy_executor::Spawner) because the executor effectively runs in a /// is returned instead of a [`Spawner`](crate::Spawner) because the executor effectively runs in a
/// different "thread" (the interrupt), so spawning tasks on it is effectively /// different "thread" (the interrupt), so spawning tasks on it is effectively
/// sending them. /// sending them.
/// ///
/// To obtain a [`Spawner`](embassy_executor::Spawner) for this executor, use [`Spawner::for_current_executor()`](embassy_executor::Spawner::for_current_executor()) from /// To obtain a [`Spawner`](crate::Spawner) for this executor, use [`Spawner::for_current_executor()`](crate::Spawner::for_current_executor()) from
/// a task running in it. /// a task running in it.
/// ///
/// # Interrupt requirements /// # Interrupt requirements
@ -195,6 +195,7 @@ mod interrupt {
/// You must set the interrupt priority before calling this method. You MUST NOT /// You must set the interrupt priority before calling this method. You MUST NOT
/// do it after. /// do it after.
/// ///
/// [`SendSpawner`]: crate::SendSpawner
pub fn start(&'static self, irq: impl InterruptNumber) -> crate::SendSpawner { pub fn start(&'static self, irq: impl InterruptNumber) -> crate::SendSpawner {
if critical_section::with(|cs| self.started.borrow(cs).replace(true)) { if critical_section::with(|cs| self.started.borrow(cs).replace(true)) {
panic!("InterruptExecutor::start() called multiple times on the same executor."); panic!("InterruptExecutor::start() called multiple times on the same executor.");
@ -215,7 +216,7 @@ mod interrupt {
/// Get a SendSpawner for this executor /// Get a SendSpawner for this executor
/// ///
/// This returns a [`SendSpawner`] you can use to spawn tasks on this /// This returns a [`SendSpawner`](crate::SendSpawner) you can use to spawn tasks on this
/// executor. /// executor.
/// ///
/// This MUST only be called on an executor that has already been started. /// This MUST only be called on an executor that has already been started.

2
embassy-executor/src/raw/waker.rs
View File

@ -26,7 +26,7 @@ pub(crate) unsafe fn from_task(p: TaskRef) -> Waker {
/// (1 word) instead of full Wakers (2 words). This saves a bit of RAM and helps /// (1 word) instead of full Wakers (2 words). This saves a bit of RAM and helps
/// avoid dynamic dispatch. /// avoid dynamic dispatch.
/// ///
/// You can use the returned task pointer to wake the task with [`wake_task`](super::wake_task). /// You can use the returned task pointer to wake the task with [`wake_task`].
/// ///
/// # Panics /// # Panics
/// ///