Fix so deny(missing_docs) work

examples/async-task-multiple-prios.rs

@@ -1,6 +1,9 @@
+//! examples/async-task-multiple-prios.rs
+
 #![no_main]
 #![no_std]
 #![feature(type_alias_impl_trait)]
+#![deny(missing_docs)]
 
 use panic_semihosting as _;
 

examples/async-task.rs

@@ -1,6 +1,9 @@
+//! examples/async-task.rs
+
 #![no_main]
 #![no_std]
 #![feature(type_alias_impl_trait)]
+#![deny(missing_docs)]
 
 use panic_semihosting as _;
 

examples/big-struct-opt.rs

@@ -6,6 +6,7 @@
 #![no_main]
 #![no_std]
 #![feature(type_alias_impl_trait)]
+#![deny(missing_docs)]
 
 use panic_semihosting as _;
 

examples/binds.rs

@@ -4,6 +4,7 @@
 #![deny(warnings)]
 #![no_main]
 #![no_std]
+#![deny(missing_docs)]
 
 use panic_semihosting as _;
 

examples/complex.rs

@@ -2,6 +2,7 @@
 
 #![deny(unsafe_code)]
 #![deny(warnings)]
+#![deny(missing_docs)]
 #![no_main]
 #![no_std]
 

examples/declared_locals.rs

@@ -2,6 +2,7 @@
 
 #![deny(unsafe_code)]
 #![deny(warnings)]
+#![deny(missing_docs)]
 #![no_main]
 #![no_std]
 

examples/destructure.rs

@@ -2,6 +2,7 @@
 
 #![deny(unsafe_code)]
 #![deny(warnings)]
+#![deny(missing_docs)]
 #![no_main]
 #![no_std]
 #![feature(type_alias_impl_trait)]

examples/extern_binds.rs

@@ -2,6 +2,7 @@
 
 #![deny(unsafe_code)]
 #![deny(warnings)]
+#![deny(missing_docs)]
 #![no_main]
 #![no_std]
 

examples/extern_spawn.rs

@@ -2,6 +2,7 @@
 
 #![deny(unsafe_code)]
 #![deny(warnings)]
+#![deny(missing_docs)]
 #![no_main]
 #![no_std]
 #![feature(type_alias_impl_trait)]

examples/generics.rs

@@ -2,6 +2,7 @@
 
 #![deny(unsafe_code)]
 #![deny(warnings)]
+#![deny(missing_docs)]
 #![no_main]
 #![no_std]
 

examples/hardware.rs

@@ -2,6 +2,7 @@
 
 #![deny(unsafe_code)]
 #![deny(warnings)]
+#![deny(missing_docs)]
 #![no_main]
 #![no_std]
 

examples/idle-wfi.rs

@@ -2,6 +2,7 @@
 
 #![deny(unsafe_code)]
 #![deny(warnings)]
+#![deny(missing_docs)]
 #![no_main]
 #![no_std]
 

examples/idle.rs

@@ -2,6 +2,7 @@
 
 #![deny(unsafe_code)]
 #![deny(warnings)]
+#![deny(missing_docs)]
 #![no_main]
 #![no_std]
 

examples/init.rs

@@ -2,6 +2,7 @@
 
 #![deny(unsafe_code)]
 #![deny(warnings)]
+#![deny(missing_docs)]
 #![no_main]
 #![no_std]
 

examples/locals.rs

@@ -2,6 +2,7 @@
 
 #![feature(type_alias_impl_trait)]
 #![deny(unsafe_code)]
+#![deny(missing_docs)]
 #![deny(warnings)]
 #![no_main]
 #![no_std]

examples/lock.rs

@@ -2,6 +2,7 @@
 
 #![deny(unsafe_code)]
 #![deny(warnings)]
+#![deny(missing_docs)]
 #![no_main]
 #![no_std]
 #![feature(type_alias_impl_trait)]

examples/multilock.rs

@@ -2,6 +2,7 @@
 
 #![deny(unsafe_code)]
 #![deny(warnings)]
+#![deny(missing_docs)]
 #![no_main]
 #![no_std]
 #![feature(type_alias_impl_trait)]

examples/not-sync.rs

@@ -2,6 +2,7 @@
 
 // #![deny(unsafe_code)]
 #![deny(warnings)]
+#![deny(missing_docs)]
 #![no_main]
 #![no_std]
 #![feature(type_alias_impl_trait)]
@@ -9,6 +10,7 @@
 use core::marker::PhantomData;
 use panic_semihosting as _;
 
+/// Not sync
 pub struct NotSync {
     _0: PhantomData<*const ()>,
     data: u32,

examples/only-shared-access.rs

@@ -2,6 +2,7 @@
 
 #![deny(unsafe_code)]
 #![deny(warnings)]
+#![deny(missing_docs)]
 #![no_main]
 #![no_std]
 #![feature(type_alias_impl_trait)]

examples/peripherals-taken.rs

@@ -1,5 +1,8 @@
+//! examples/peripherals-taken.rs
+
 #![deny(unsafe_code)]
 #![deny(warnings)]
+#![deny(missing_docs)]
 #![no_main]
 #![no_std]
 

examples/preempt.rs

@@ -3,6 +3,7 @@
 #![no_main]
 #![no_std]
 #![feature(type_alias_impl_trait)]
+#![deny(missing_docs)]
 
 use panic_semihosting as _;
 use rtic::app;

examples/ramfunc.rs

@@ -1,9 +1,11 @@
 //! examples/ramfunc.rs
 
 #![deny(warnings)]
+#![deny(missing_docs)]
 #![no_main]
 #![no_std]
 #![feature(type_alias_impl_trait)]
+
 use panic_semihosting as _;
 
 #[rtic::app(

examples/resource-user-struct.rs

@@ -2,6 +2,7 @@
 
 #![deny(unsafe_code)]
 #![deny(warnings)]
+#![deny(missing_docs)]
 #![no_main]
 #![no_std]
 

examples/shared.rs

@@ -2,6 +2,7 @@
 
 #![deny(unsafe_code)]
 #![deny(warnings)]
+#![deny(missing_docs)]
 #![no_main]
 #![no_std]
 

examples/smallest.rs

@@ -2,6 +2,7 @@
 
 #![no_main]
 #![no_std]
+#![deny(missing_docs)]
 
 use panic_semihosting as _; // panic handler
 use rtic::app;

examples/spawn.rs

@@ -2,6 +2,7 @@
 
 #![deny(unsafe_code)]
 #![deny(warnings)]
+#![deny(missing_docs)]
 #![no_main]
 #![no_std]
 #![feature(type_alias_impl_trait)]

examples/static.rs

@@ -2,6 +2,7 @@
 
 #![deny(unsafe_code)]
 #![deny(warnings)]
+#![deny(missing_docs)]
 #![no_main]
 #![no_std]
 #![feature(type_alias_impl_trait)]

examples/t-binds.rs

@@ -2,6 +2,7 @@
 
 #![deny(unsafe_code)]
 #![deny(warnings)]
+#![deny(missing_docs)]
 #![no_main]
 #![no_std]
 

examples/t-cfg-resources.rs

@@ -1,7 +1,8 @@
 //! [compile-pass] check that `#[cfg]` attributes applied on resources work
-//!
+
 #![no_main]
 #![no_std]
+#![deny(missing_docs)]
 
 use panic_semihosting as _;
 

examples/t-htask-main.rs

@@ -1,5 +1,8 @@
+//! examples/h-task-main.rs
+
 #![deny(unsafe_code)]
 #![deny(warnings)]
+#![deny(missing_docs)]
 #![no_main]
 #![no_std]
 

examples/t-idle-main.rs

@@ -1,5 +1,8 @@
+//! examples/t-idle-main.rs
+
 #![deny(unsafe_code)]
 #![deny(warnings)]
+#![deny(missing_docs)]
 #![no_main]
 #![no_std]
 

examples/t-late-not-send.rs

@@ -2,11 +2,12 @@
 
 #![no_main]
 #![no_std]
+#![deny(missing_docs)]
 
 use core::marker::PhantomData;
-
 use panic_semihosting as _;
 
+/// Not send
 pub struct NotSend {
     _0: PhantomData<*const ()>,
 }

examples/task.rs

@@ -2,6 +2,7 @@
 
 #![deny(unsafe_code)]
 #![deny(warnings)]
+#![deny(missing_docs)]
 #![no_main]
 #![no_std]
 #![feature(type_alias_impl_trait)]

examples/zero-prio-task.rs

@@ -1,10 +1,14 @@
+//! examples/zero-prio-task.rs
+
 #![no_main]
 #![no_std]
 #![feature(type_alias_impl_trait)]
+#![deny(missing_docs)]
 
 use core::marker::PhantomData;
 use panic_semihosting as _;
 
+/// Does not impl send
 pub struct NotSend {
     _0: PhantomData<*const ()>,
 }

macros/src/codegen/local_resources_struct.rs

@@ -50,6 +50,7 @@ pub fn codegen(ctxt: Context, app: &App) -> (TokenStream2, TokenStream2) {
 
         fields.push(quote!(
             #(#cfgs)*
+            #[allow(missing_docs)]
             pub #name: &#lt mut #ty
         ));
 
@@ -88,6 +89,7 @@ pub fn codegen(ctxt: Context, app: &App) -> (TokenStream2, TokenStream2) {
     let constructor = quote!(
         impl<'a> #ident<'a> {
             #[inline(always)]
+            #[allow(missing_docs)]
             pub unsafe fn new() -> Self {
                 #ident {
                     #(#values,)*

macros/src/codegen/module.rs

@@ -114,6 +114,7 @@ pub fn codegen(ctxt: Context, app: &App, analysis: &Analysis) -> TokenStream2 {
         #(#cfgs)*
         impl<'a> #internal_context_name<'a> {
             #[inline(always)]
+            #[allow(missing_docs)]
             pub unsafe fn new(#core) -> Self {
                 #internal_context_name {
                     __rtic_internal_p: ::core::marker::PhantomData,

macros/src/codegen/shared_resources_struct.rs

@@ -47,16 +47,19 @@ pub fn codegen(ctxt: Context, app: &App) -> (TokenStream2, TokenStream2) {
 
             fields.push(quote!(
                 #(#cfgs)*
+                #[allow(missing_docs)]
                 pub #name: &#lt #mut_ #ty
             ));
         } else if access.is_shared() {
             fields.push(quote!(
                 #(#cfgs)*
+                #[allow(missing_docs)]
                 pub #name: &'a #ty
             ));
         } else {
             fields.push(quote!(
                 #(#cfgs)*
+                #[allow(missing_docs)]
                 pub #name: shared_resources::#shared_name<'a>
             ));
 
@@ -103,6 +106,7 @@ pub fn codegen(ctxt: Context, app: &App) -> (TokenStream2, TokenStream2) {
     let constructor = quote!(
         impl<'a> #ident<'a> {
             #[inline(always)]
+            #[allow(missing_docs)]
             pub unsafe fn new() -> Self {
                 #ident {
                     #(#values,)*