zephyr: Documentation fixes

Fix various broken links in documentation comments.

Signed-off-by: David Brown <[email protected]>

Author: d3zd3z

zephyr/src/embassy.rs

@@ -62,9 +62,6 @@
 //! It is perfectly permissible to use the `executor-thread` feature from embassy-executor on
 //! Zephyr, within the following guidelines:
 //!
-//! - The executor is incompatible with the async executor provided within [`crate::kio`], and
-//!   because there are no features to enable this, this functions will still be accessible.  Be
-//!   careful.  You should enable `no-kio` in the zephyr crate to hide these functions.
 //! - This executor does not coordinate with the scheduler on Zephyr, but uses an
 //!   architecture-specific mechanism when there is no work. On Cortex-M, this is the 'wfe'
 //!   instruction, on riscv32, the 'wfi' instruction.  This means that no tasks of lower priority
@@ -74,12 +71,7 @@
 //!
 //! ## Caveats
 //!
-//! The executor provided by Embassy is fundamentally incompatible with the executor provided by
-//! this crate's [`crate::kio`] and [`crate::work::futures`].  Trying to use the functionality
-//! provided by operations, such as [`Semaphore::take_async`], will generally result in a panic.
-//! These routines are conditionally compiled out when `executor-zephyr` is enabled, but there is no
-//! way for this crate to detect the use of embassy's `executor-threaded`.  Combining these will
-//! result in undefined behavior, likely difficult to debug crashes.
+//! The executor currently doesn't support async waits on Zephyr primitives, such as Semaphore.
 //!
 //! [`Semaphore::take_async`]: crate::sys::sync::Semaphore::take_async
 

zephyr/src/object.rs

@@ -231,7 +231,7 @@ pub trait ObjectInit<T> {
     /// Initialize the object.
     ///
     /// This is called upon first use.  The address given may (and generally will) be different than
-    /// the initial address given to the `setup` call in the [`ZephyrObject::new`] constructor.
+    /// the initial address given to the `setup` call in the [`ZephyrObject::new_raw`] constructor.
     /// After this is called, all subsequent calls to [`ZephyrObject::get`] will return the same
     /// address, or panic.
     fn init(item: *mut T);

zephyr/src/sync.rs

@@ -33,7 +33,7 @@ mod pinweak {
 
     /// Safe Pinned Weak references.
     ///
-    /// Pin<Arc<T>> can't be converted to/from Weak safely, because there is know way to know if a given
+    /// `Pin<Arc<T>>` can't be converted to/from Weak safely, because there is know way to know if a given
     /// weak reference came from a pinned Arc.  This wraps the weak reference in a new type so we know
     /// that it came from a pinned Arc.
     ///