rustdoc cleanup: use rustdoc attribute

Author: phip1611

.github/workflows/rust.yml

@@ -117,7 +117,7 @@ jobs:
           cargo xtask clippy --warnings-as-errors
 
       - name: Run cargo doc
-        run: cargo xtask doc --warnings-as-errors
+        run: cargo xtask doc
 
   miri:
     name: Run unit tests and doctests under Miri

src/data_types/strs.rs

@@ -347,12 +347,10 @@ impl PartialEq<CString16> for &CStr16 {
 /// [`CStr16`] can't be directly constructed. `UnalignedCStr16` instead
 /// takes a pointer to the unaligned field, which is allowed. The
 /// resulting unaligned string cannot be used directly, but must be
-/// converted to an aligned form first with [`to_cstr16`] or
-/// [`to_cstring16`].
+/// converted to an aligned form first with [`to_cstr16`].
 ///
 /// [`repr(packed)`]: https://doc.rust-lang.org/nomicon/other-reprs.html#reprpacked
 /// [`to_cstr16`]: Self::to_cstr16
-/// [`to_cstring16`]: Self::to_cstring16
 #[derive(Debug)]
 pub struct UnalignedCStr16<'a> {
     data: *const u16,

src/lib.rs

@@ -33,6 +33,8 @@
 // Enable some additional warnings and lints.
 #![warn(clippy::ptr_as_ptr, missing_docs, unused)]
 #![deny(clippy::all)]
+#![deny(rustdoc::all)]
+#![allow(rustdoc::missing_doc_code_examples)]
 
 // `uefi-exts` requires access to memory allocation APIs.
 #[cfg(feature = "exts")]

uefi-macros/src/lib.rs

@@ -1,4 +1,8 @@
 #![recursion_limit = "128"]
+#![deny(rustdoc::all)]
+#![allow(rustdoc::missing_doc_code_examples)]
+
+//! Code generation macros for the `uefi` crate.
 
 extern crate proc_macro;
 

uefi-services/src/lib.rs

@@ -19,6 +19,8 @@
 #![no_std]
 #![feature(alloc_error_handler)]
 #![feature(abi_efiapi)]
+#![deny(rustdoc::all)]
+#![allow(rustdoc::missing_doc_code_examples)]
 
 #[macro_use]
 extern crate log;

xtask/src/cargo.rs

@@ -146,9 +146,6 @@ impl Cargo {
             }
             CargoAction::Doc { open } => {
                 action = "doc";
-                if self.warnings_as_errors {
-                    cmd.env("RUSTDOCFLAGS", "-Dwarnings");
-                }
                 if open {
                     extra_args.push("--open");
                 }
@@ -237,11 +234,11 @@ mod tests {
             packages: vec![Package::Uefi, Package::Xtask],
             release: false,
             target: None,
-            warnings_as_errors: true,
+            warnings_as_errors: false,
         };
         assert_eq!(
             command_to_string(&cargo.command().unwrap()),
-            "RUSTDOCFLAGS=-Dwarnings cargo doc --package uefi --package xtask --features alloc --open"
+            "cargo doc --package uefi --package xtask --features alloc --open"
         );
     }
 }