Deny missing_docs for all examples

40 files changed, 53 insertions, 1 deletions

diff --git a/examples/binds.rs b/examples/binds.rs
index 601f245a..1b0c8c5b 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 7ab437f2..36c496b7 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 e625249a..550829be 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 90fb9ccc..b5b97831 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 7dcc5421..74ee8db2 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 2be71d22..73df025d 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 52d354bc..cb621496 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 fd577a6c..70b0dd7e 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 c2186cb7..bfc85cfc 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 2eec2dbc..446d31a7 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 6243d562..bc4959fb 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 590bf6ab..a7fdb47a 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 42fd7b49..5e52620d 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 ad04fd68..ccec9bf2 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 7a101496..afd3b98c 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 18897753..9e112be4 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 32853e44..6e5faadb 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 16f3b338..5b3e0bcc 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 a5c89199..8a6a12d5 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 13e3b98d..9550a501 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 83df8d7d..c7085cd5 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 aa79ad56..68af04a6 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 c9826d09..b32827ab 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 11162102..ad8a5496 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 35ebb52f..4719bdb7 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 5d66735c..13ca7c85 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 d542c0e6..cc9b9a11 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 5014e216..4b9aa442 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 049af18f..956a2554 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 39a5b16c..37a88560 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 58e73dad..9b86929d 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 58d64e41..b43a19a3 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 75b7f85f..50ae7e7a 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 abeb9c52..efafcc7a 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 12479c0a..822a2eea 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 37189faf..2b17b2ee 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 1adc9bf0..48635b2a 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 5ec42087..f3979dd6 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 2bd771d7..7483a849 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 d24fca62..9757f2f5 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]