Add missing docs

Author: jamesmunns

source/scoped-mutex-traits/src/lib.rs

@@ -1,5 +1,19 @@
+//! Scoped Mutex Traits
+//!
+//! This crate provides traits that are aimed at compatibility for scoped mutexes.
+//!
+//! Compared to the more general traits provided by the [`lock_api`] crate, these traits
+//! are aimed at being more compatible with implementations based on critical sections,
+//! are easier to work with in a nested or strictly LIFO pattern.
+//!
+//! [`lock_api`]: https://docs.rs/lock_api/
+#![deny(missing_docs)]
 #![cfg_attr(not(feature = "std"), no_std)]
 
+/// Const Init Trait
+///
+/// This trait is intended for use when implementers of [`ScopedRawMutex`] that can
+/// be constructed in const context, e.g. for placing in a `static`
 pub trait ConstInit {
     /// Create a new instance.
     ///

source/scoped-mutex/src/lib.rs

@@ -1,5 +1,5 @@
 //! Scoped Mutex Crate
-
+#![deny(missing_docs)]
 #![cfg_attr(not(feature = "std"), no_std)]
 
 pub mod raw_impls;

source/scoped-mutex/src/raw_impls.rs

@@ -13,6 +13,7 @@ use scoped_mutex_traits::{ConstInit, ScopedRawMutex};
 
 #[cfg(feature = "impl-critical-section")]
 pub mod cs {
+    //! Critical Section based implementation
 
     use super::*;
 
@@ -74,6 +75,7 @@ pub mod cs {
 // ================
 
 pub mod local {
+    //! Locally usable based implementation
     use super::*;
 
     /// A mutex that allows borrowing data in local context.
@@ -135,6 +137,8 @@ pub mod local {
 
 #[cfg(all(feature = "impl-unsafe-cortex-m-single-core", cortex_m))]
 pub mod single_core_thread_mode {
+    //! A single-core safe implementation that does not require a critical section
+
     use super::*;
 
     /// A "mutex" that only allows borrowing from thread mode.