zephyr: Fill in some missing doc comments

Fix doc build errors by filling in missing documentation comments.

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

Author: d3zd3z

zephyr/src/lib.rs

@@ -82,6 +82,7 @@ fn panic(info :&PanicInfo) -> ! {
     }
 }
 
+/// Set the logger that the log crate will use to a printk-based logger within Zephyr.
 #[cfg(CONFIG_PRINTK)]
 pub fn set_logger() {
     printk::set_printk_logger();
@@ -111,6 +112,11 @@ pub mod alloc_impl;
 // If we have allocation, we can also support logging.
 #[cfg(CONFIG_RUST_ALLOC)]
 pub mod log {
+    //! A simple logging system using printk.
+    //!
+    //! As a stopgap for full logging, this allows Rust's logging to be transmitted via printk
+    //! messages.
+
     #[cfg(CONFIG_LOG)]
     compile_error!("Rust with CONFIG_LOG is not yet supported");
 

zephyr/src/log/log_printk.rs

@@ -20,20 +20,10 @@ extern "C" {
     fn printk(fmt: *const i8, ...);
 }
 
+#[doc(hidden)]
 pub fn log_message(message: &str) {
     let raw = CString::new(message).expect("CString::new failed");
     unsafe {
         printk(c"%s\n".as_ptr(), raw.as_ptr());
     }
 }
-
-// We assume the log message is accessible at $crate::log::log_message.
-#[macro_export]
-macro_rules! println {
-    ($($arg:tt)+) => {
-        {
-            let message = $crate::log::format!($($arg)+);
-            $crate::log::log_message(&message);
-        }
-    };
-}

zephyr/src/printk.rs

@@ -74,12 +74,14 @@ static PRINTK_LOGGER: PrintkLogger = PrintkLogger;
 
 // The cfg matches what is in the log crate, which doesn't use portable atomic, and assumes the
 // racy init when not the case.
+#[doc(hidden)]
 #[cfg(target_has_atomic = "ptr")]
 pub fn set_printk_logger() {
     log::set_logger(&PRINTK_LOGGER).unwrap();
     log::set_max_level(LevelFilter::Info);
 }
 
+#[doc(hidden)]
 #[cfg(not(target_has_atomic = "ptr"))]
 pub fn set_printk_logger() {
     unsafe {

zephyr/src/sys.rs

@@ -145,6 +145,12 @@ pub mod flash {
 
     use crate::raw;
 
+    /// A flash controller
+    ///
+    /// This is a wrapper around the `struct device` in Zephyr that represents a flash controller.
+    /// Using the flash controller allows flash operations on the entire device.  See
+    /// [`FlashPartition`] for a wrapper that limits the operation to a partition as defined in the
+    /// DT.
     #[allow(dead_code)]
     pub struct FlashController {
         pub(crate) device: *const raw::device,