Deny missing_docs for all examples

40 files changed, 53 insertions, 1 deletions

diff --git a/examples/binds.rs b/examples/binds.rs
index 601f245..1b0c8c5 100644
--- a/examples/binds.rs
+++ b/examples/binds.rs
@@ -2,6 +2,7 @@
 
 #![deny(unsafe_code)]
 #![deny(warnings)]
+#![deny(missing_docs)]
 #![no_main]
 #![no_std]
 
diff --git a/examples/cancel-reschedule.rs b/examples/cancel-reschedule.rs
index 7ab437f..36c496b 100644
--- a/examples/cancel-reschedule.rs
+++ b/examples/cancel-reschedule.rs
@@ -2,6 +2,7 @@
 
 #![deny(unsafe_code)]
 #![deny(warnings)]
+#![deny(missing_docs)]
 #![no_main]
 #![no_std]
 
diff --git a/examples/capacity.rs b/examples/capacity.rs
index e625249..550829b 100644
--- a/examples/capacity.rs
+++ b/examples/capacity.rs
@@ -2,6 +2,7 @@
 
 #![deny(unsafe_code)]
 #![deny(warnings)]
+#![deny(missing_docs)]
 #![no_main]
 #![no_std]
 
diff --git a/examples/cfg-whole-task.rs b/examples/cfg-whole-task.rs
index 90fb9cc..b5b9783 100644
--- a/examples/cfg-whole-task.rs
+++ b/examples/cfg-whole-task.rs
@@ -2,6 +2,7 @@
 
 #![deny(unsafe_code)]
 #![deny(warnings)]
+#![deny(missing_docs)]
 #![no_main]
 #![no_std]
 
diff --git a/examples/common.rs b/examples/common.rs
index 7dcc542..74ee8db 100644
--- a/examples/common.rs
+++ b/examples/common.rs
@@ -2,6 +2,7 @@
 
 #![deny(unsafe_code)]
 #![deny(warnings)]
+#![deny(missing_docs)]
 #![no_main]
 #![no_std]
 
diff --git a/examples/complex.rs b/examples/complex.rs
index 2be71d2..73df025 100644
--- a/examples/complex.rs
+++ b/examples/complex.rs
@@ -2,6 +2,7 @@
 
 #![deny(unsafe_code)]
 #![deny(warnings)]
+#![deny(missing_docs)]
 #![no_main]
 #![no_std]
 
diff --git a/examples/declared_locals.rs b/examples/declared_locals.rs
index 52d354b..cb62149 100644
--- a/examples/declared_locals.rs
+++ b/examples/declared_locals.rs
@@ -2,6 +2,7 @@
 
 #![deny(unsafe_code)]
 #![deny(warnings)]
+#![deny(missing_docs)]
 #![no_main]
 #![no_std]
 
diff --git a/examples/destructure.rs b/examples/destructure.rs
index fd577a6..70b0dd7 100644
--- a/examples/destructure.rs
+++ b/examples/destructure.rs
@@ -2,6 +2,7 @@
 
 #![deny(unsafe_code)]
 #![deny(warnings)]
+#![deny(missing_docs)]
 #![no_main]
 #![no_std]
 
diff --git a/examples/extern_binds.rs b/examples/extern_binds.rs
index c2186cb..bfc85cf 100644
--- a/examples/extern_binds.rs
+++ b/examples/extern_binds.rs
@@ -2,6 +2,7 @@
 
 #![deny(unsafe_code)]
 #![deny(warnings)]
+#![deny(missing_docs)]
 #![no_main]
 #![no_std]
 
diff --git a/examples/extern_spawn.rs b/examples/extern_spawn.rs
index 2eec2db..446d31a 100644
--- a/examples/extern_spawn.rs
+++ b/examples/extern_spawn.rs
@@ -2,6 +2,7 @@
 
 #![deny(unsafe_code)]
 #![deny(warnings)]
+#![deny(missing_docs)]
 #![no_main]
 #![no_std]
 
diff --git a/examples/generics.rs b/examples/generics.rs
index 6243d56..bc4959f 100644
--- a/examples/generics.rs
+++ b/examples/generics.rs
@@ -2,6 +2,7 @@
 
 #![deny(unsafe_code)]
 #![deny(warnings)]
+#![deny(missing_docs)]
 #![no_main]
 #![no_std]
 
diff --git a/examples/hardware.rs b/examples/hardware.rs
index 590bf6a..a7fdb47 100644
--- a/examples/hardware.rs
+++ b/examples/hardware.rs
@@ -2,6 +2,7 @@
 
 #![deny(unsafe_code)]
 #![deny(warnings)]
+#![deny(missing_docs)]
 #![no_main]
 #![no_std]
 
diff --git a/examples/idle-wfi.rs b/examples/idle-wfi.rs
index 42fd7b4..5e52620 100644
--- a/examples/idle-wfi.rs
+++ b/examples/idle-wfi.rs
@@ -2,6 +2,7 @@
 
 #![deny(unsafe_code)]
 #![deny(warnings)]
+#![deny(missing_docs)]
 #![no_main]
 #![no_std]
 
diff --git a/examples/idle.rs b/examples/idle.rs
index ad04fd6..ccec9bf 100644
--- a/examples/idle.rs
+++ b/examples/idle.rs
@@ -2,6 +2,7 @@
 
 #![deny(unsafe_code)]
 #![deny(warnings)]
+#![deny(missing_docs)]
 #![no_main]
 #![no_std]
 
diff --git a/examples/init.rs b/examples/init.rs
index 7a10149..afd3b98 100644
--- a/examples/init.rs
+++ b/examples/init.rs
@@ -2,6 +2,7 @@
 
 #![deny(unsafe_code)]
 #![deny(warnings)]
+#![deny(missing_docs)]
 #![no_main]
 #![no_std]
 
diff --git a/examples/locals.rs b/examples/locals.rs
index 1889775..9e112be 100644
--- a/examples/locals.rs
+++ b/examples/locals.rs
@@ -2,6 +2,8 @@
 
 #![deny(unsafe_code)]
 #![deny(warnings)]
+#![deny(missing_docs)]
+#![deny(missing_docs)]
 #![no_main]
 #![no_std]
 
@@ -16,8 +18,11 @@ mod app {
 
     #[local]
     struct Local {
+        /// Local foo
         local_to_foo: i64,
+        /// Local bar
         local_to_bar: i64,
+        /// Local idle
         local_to_idle: i64,
     }
 
diff --git a/examples/lock-free.rs b/examples/lock-free.rs
index 32853e4..6e5faad 100644
--- a/examples/lock-free.rs
+++ b/examples/lock-free.rs
@@ -2,6 +2,7 @@
 
 #![deny(unsafe_code)]
 #![deny(warnings)]
+#![deny(missing_docs)]
 #![no_main]
 #![no_std]
 
diff --git a/examples/lock.rs b/examples/lock.rs
index 16f3b33..5b3e0bc 100644
--- a/examples/lock.rs
+++ b/examples/lock.rs
@@ -2,6 +2,7 @@
 
 #![deny(unsafe_code)]
 #![deny(warnings)]
+#![deny(missing_docs)]
 #![no_main]
 #![no_std]
 
diff --git a/examples/message.rs b/examples/message.rs
index a5c8919..8a6a12d 100644
--- a/examples/message.rs
+++ b/examples/message.rs
@@ -2,6 +2,7 @@
 
 #![deny(unsafe_code)]
 #![deny(warnings)]
+#![deny(missing_docs)]
 #![no_main]
 #![no_std]
 
diff --git a/examples/message_passing.rs b/examples/message_passing.rs
index 13e3b98..9550a50 100644
--- a/examples/message_passing.rs
+++ b/examples/message_passing.rs
@@ -2,6 +2,7 @@
 
 #![deny(unsafe_code)]
 #![deny(warnings)]
+#![deny(missing_docs)]
 #![no_main]
 #![no_std]
 
diff --git a/examples/multilock.rs b/examples/multilock.rs
index 83df8d7..c7085cd 100644
--- a/examples/multilock.rs
+++ b/examples/multilock.rs
@@ -2,6 +2,7 @@
 
 #![deny(unsafe_code)]
 #![deny(warnings)]
+#![deny(missing_docs)]
 #![no_main]
 #![no_std]
 
diff --git a/examples/not-sync.rs b/examples/not-sync.rs
index aa79ad5..68af04a 100644
--- a/examples/not-sync.rs
+++ b/examples/not-sync.rs
@@ -2,13 +2,16 @@
 
 // #![deny(unsafe_code)]
 #![deny(warnings)]
+#![deny(missing_docs)]
 #![no_main]
 #![no_std]
 
 use core::marker::PhantomData;
 use panic_semihosting as _;
 
+/// Not sync
 pub struct NotSync {
+    /// Phantom action
     _0: PhantomData<*const ()>,
 }
 
@@ -22,6 +25,7 @@ mod app {
 
     #[shared]
     struct Shared {
+        /// This resource is not Sync
         shared: NotSync,
     }
 
diff --git a/examples/only-shared-access.rs b/examples/only-shared-access.rs
index c9826d0..b32827a 100644
--- a/examples/only-shared-access.rs
+++ b/examples/only-shared-access.rs
@@ -2,6 +2,7 @@
 
 #![deny(unsafe_code)]
 #![deny(warnings)]
+#![deny(missing_docs)]
 #![no_main]
 #![no_std]
 
diff --git a/examples/periodic-at.rs b/examples/periodic-at.rs
index 1116210..ad8a549 100644
--- a/examples/periodic-at.rs
+++ b/examples/periodic-at.rs
@@ -2,6 +2,7 @@
 
 #![deny(unsafe_code)]
 #![deny(warnings)]
+#![deny(missing_docs)]
 #![no_main]
 #![no_std]
 
diff --git a/examples/periodic-at2.rs b/examples/periodic-at2.rs
index 35ebb52..4719bdb 100644
--- a/examples/periodic-at2.rs
+++ b/examples/periodic-at2.rs
@@ -2,6 +2,7 @@
 
 #![deny(unsafe_code)]
 #![deny(warnings)]
+#![deny(missing_docs)]
 #![no_main]
 #![no_std]
 
diff --git a/examples/periodic.rs b/examples/periodic.rs
index 5d66735..13ca7c8 100644
--- a/examples/periodic.rs
+++ b/examples/periodic.rs
@@ -2,6 +2,7 @@
 
 #![deny(unsafe_code)]
 #![deny(warnings)]
+#![deny(missing_docs)]
 #![no_main]
 #![no_std]
 
diff --git a/examples/peripherals-taken.rs b/examples/peripherals-taken.rs
index d542c0e..cc9b9a1 100644
--- a/examples/peripherals-taken.rs
+++ b/examples/peripherals-taken.rs
@@ -1,5 +1,7 @@
-#![deny(unsafe_code)]
+//! examples/peripherals-taken.rs
 #![deny(warnings)]
+#![deny(unsafe_code)]
+#![deny(missing_docs)]
 #![no_main]
 #![no_std]
 
diff --git a/examples/pool.rs b/examples/pool.rs
index 5014e21..4b9aa44 100644
--- a/examples/pool.rs
+++ b/examples/pool.rs
@@ -2,6 +2,7 @@
 
 #![deny(unsafe_code)]
 #![deny(warnings)]
+#![deny(missing_docs)]
 #![no_main]
 #![no_std]
 
diff --git a/examples/ramfunc.rs b/examples/ramfunc.rs
index 049af18..956a255 100644
--- a/examples/ramfunc.rs
+++ b/examples/ramfunc.rs
@@ -1,6 +1,7 @@
 //! examples/ramfunc.rs
 
 #![deny(warnings)]
+#![deny(missing_docs)]
 #![no_main]
 #![no_std]
 
diff --git a/examples/resource-user-struct.rs b/examples/resource-user-struct.rs
index 39a5b16..37a8856 100644
--- a/examples/resource-user-struct.rs
+++ b/examples/resource-user-struct.rs
@@ -2,6 +2,7 @@
 
 #![deny(unsafe_code)]
 #![deny(warnings)]
+#![deny(missing_docs)]
 #![no_main]
 #![no_std]
 
diff --git a/examples/schedule.rs b/examples/schedule.rs
index 58e73da..9b86929 100644
--- a/examples/schedule.rs
+++ b/examples/schedule.rs
@@ -2,6 +2,7 @@
 
 #![deny(unsafe_code)]
 #![deny(warnings)]
+#![deny(missing_docs)]
 #![no_main]
 #![no_std]
 
diff --git a/examples/shared.rs b/examples/shared.rs
index 58d64e4..b43a19a 100644
--- a/examples/shared.rs
+++ b/examples/shared.rs
@@ -2,6 +2,7 @@
 
 #![deny(unsafe_code)]
 #![deny(warnings)]
+#![deny(missing_docs)]
 #![no_main]
 #![no_std]
 
@@ -15,7 +16,9 @@ mod app {
 
     #[shared]
     struct Shared {
+        /// Producer
         p: Producer<'static, u32, 5>,
+        /// Consumer
         c: Consumer<'static, u32, 5>,
     }
 
diff --git a/examples/spawn.rs b/examples/spawn.rs
index 75b7f85..50ae7e7 100644
--- a/examples/spawn.rs
+++ b/examples/spawn.rs
@@ -2,6 +2,7 @@
 
 #![deny(unsafe_code)]
 #![deny(warnings)]
+#![deny(missing_docs)]
 #![no_main]
 #![no_std]
 
diff --git a/examples/static.rs b/examples/static.rs
index abeb9c5..efafcc7 100644
--- a/examples/static.rs
+++ b/examples/static.rs
@@ -2,6 +2,7 @@
 
 #![deny(unsafe_code)]
 #![deny(warnings)]
+#![deny(missing_docs)]
 #![no_main]
 #![no_std]
 
diff --git a/examples/t-binds.rs b/examples/t-binds.rs
index 12479c0..822a2ee 100644
--- a/examples/t-binds.rs
+++ b/examples/t-binds.rs
@@ -2,6 +2,7 @@
 
 #![deny(unsafe_code)]
 #![deny(warnings)]
+#![deny(missing_docs)]
 #![no_main]
 #![no_std]
 
diff --git a/examples/t-htask-main.rs b/examples/t-htask-main.rs
index 37189fa..2b17b2e 100644
--- a/examples/t-htask-main.rs
+++ b/examples/t-htask-main.rs
@@ -1,5 +1,7 @@
+//! examples/t-htask-main.rs
 #![deny(unsafe_code)]
 #![deny(warnings)]
+#![deny(missing_docs)]
 #![no_main]
 #![no_std]
 
diff --git a/examples/t-idle-main.rs b/examples/t-idle-main.rs
index 1adc9bf..48635b2 100644
--- a/examples/t-idle-main.rs
+++ b/examples/t-idle-main.rs
@@ -1,5 +1,7 @@
+//! examples/t-idle-main.rs
 #![deny(unsafe_code)]
 #![deny(warnings)]
+#![deny(missing_docs)]
 #![no_main]
 #![no_std]
 
diff --git a/examples/t-schedule.rs b/examples/t-schedule.rs
index 5ec4208..f3979dd 100644
--- a/examples/t-schedule.rs
+++ b/examples/t-schedule.rs
@@ -2,6 +2,7 @@
 
 #![deny(unsafe_code)]
 #![deny(warnings)]
+#![deny(missing_docs)]
 #![no_main]
 #![no_std]
 
diff --git a/examples/t-spawn.rs b/examples/t-spawn.rs
index 2bd771d..7483a84 100644
--- a/examples/t-spawn.rs
+++ b/examples/t-spawn.rs
@@ -2,6 +2,7 @@
 
 #![deny(unsafe_code)]
 #![deny(warnings)]
+#![deny(missing_docs)]
 #![no_main]
 #![no_std]
 
diff --git a/examples/task.rs b/examples/task.rs
index d24fca6..9757f2f 100644
--- a/examples/task.rs
+++ b/examples/task.rs
@@ -2,6 +2,7 @@
 
 #![deny(unsafe_code)]
 #![deny(warnings)]
+#![deny(missing_docs)]
 #![no_main]
 #![no_std]