From 40d5ace1112e7cc7ce8fc841ae59fb90c3c310f1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Henrik=20Tj=C3=A4der?= Date: Sat, 21 Jan 2023 23:10:43 +0100 Subject: [PATCH] Deny missing_docs for all examples --- examples/binds.rs | 1 + examples/cancel-reschedule.rs | 1 + examples/capacity.rs | 1 + examples/cfg-whole-task.rs | 1 + examples/common.rs | 1 + examples/complex.rs | 1 + examples/declared_locals.rs | 1 + examples/destructure.rs | 1 + examples/extern_binds.rs | 1 + examples/extern_spawn.rs | 1 + examples/generics.rs | 1 + examples/hardware.rs | 1 + examples/idle-wfi.rs | 1 + examples/idle.rs | 1 + examples/init.rs | 1 + examples/locals.rs | 5 +++++ examples/lock-free.rs | 1 + examples/lock.rs | 1 + examples/message.rs | 1 + examples/message_passing.rs | 1 + examples/multilock.rs | 1 + examples/not-sync.rs | 4 ++++ examples/only-shared-access.rs | 1 + examples/periodic-at.rs | 1 + examples/periodic-at2.rs | 1 + examples/periodic.rs | 1 + examples/peripherals-taken.rs | 4 +++- examples/pool.rs | 1 + examples/ramfunc.rs | 1 + examples/resource-user-struct.rs | 1 + examples/schedule.rs | 1 + examples/shared.rs | 3 +++ examples/spawn.rs | 1 + examples/static.rs | 1 + examples/t-binds.rs | 1 + examples/t-htask-main.rs | 2 ++ examples/t-idle-main.rs | 2 ++ examples/t-schedule.rs | 1 + examples/t-spawn.rs | 1 + examples/task.rs | 1 + 40 files changed, 53 insertions(+), 1 deletion(-) diff --git a/examples/binds.rs b/examples/binds.rs index 601f245a0c..1b0c8c5beb 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 7ab437f272..36c496b71a 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 e625249af8..550829be32 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 90fb9ccc9b..b5b978312e 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 7dcc5421a9..74ee8db2c8 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 2be71d22fb..73df025d2f 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 52d354bc9a..cb6214960f 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 fd577a6c9c..70b0dd7e6f 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 c2186cb7fb..bfc85cfc82 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 2eec2dbc49..446d31a77b 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 6243d562e8..bc4959fb7b 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 590bf6ab66..a7fdb47a37 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 42fd7b49e0..5e52620d45 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 ad04fd68e4..ccec9bf273 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 7a10149692..afd3b98ce9 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 1889775316..9e112be4b3 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 32853e44ed..6e5faadbf2 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 16f3b33812..5b3e0bcc3c 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 a5c89199ee..8a6a12d5f4 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 13e3b98de3..9550a5010a 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 83df8d7d4e..c7085cd51c 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 aa79ad5626..68af04a6c6 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 c9826d09b0..b32827abf2 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 1116210248..ad8a5496f2 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 35ebb52f5b..4719bdb7e4 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 5d66735c28..13ca7c852c 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 d542c0e64d..cc9b9a11ce 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 5014e216d3..4b9aa44223 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 049af18fbe..956a2554d8 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 39a5b16c8a..37a885609f 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 58e73dad18..9b86929d93 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 58d64e4191..b43a19a3c5 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 75b7f85fe8..50ae7e7a75 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 abeb9c525a..efafcc7aa8 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 12479c0ad4..822a2eeabb 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 37189faf76..2b17b2ee02 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 1adc9bf044..48635b2ab2 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 5ec420873d..f3979dd62f 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 2bd771d7f6..7483a8494b 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 d24fca6261..9757f2f559 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]