deny(missing_docs) at crate root

To help flag missing documentation on publicly accessible APIs.
This commit is contained in:
David Tolnay 2021-04-16 16:08:52 -07:00
parent 9b54630472
commit cb07a846cd
No known key found for this signature in database
GPG Key ID: F9BA143B95FF6D82
14 changed files with 23 additions and 1 deletions

View File

@ -213,6 +213,7 @@ pub struct StackString {
space: MaybeUninit<[usize; 8]>,
}
#[allow(missing_docs)]
impl StackString {
pub fn new() -> Self {
StackString {

View File

@ -16,6 +16,7 @@ impl Display for Exception {
impl std::error::Error for Exception {}
impl Exception {
#[allow(missing_docs)]
pub fn what(&self) -> &str {
&self.what
}

View File

@ -167,6 +167,7 @@ pub mod kind {
/// indirection.
pub enum Trivial {}
#[allow(missing_docs)]
pub trait Kind: private::Sealed {}
impl Kind for Opaque {}
impl Kind for Trivial {}

View File

@ -1,3 +1,5 @@
#![allow(missing_docs)]
use core::ffi::c_void;
#[repr(C)]

View File

@ -365,7 +365,7 @@
#![no_std]
#![doc(html_root_url = "https://docs.rs/cxx/1.0.45")]
#![deny(improper_ctypes, improper_ctypes_definitions)]
#![deny(improper_ctypes, improper_ctypes_definitions, missing_docs)]
#![allow(non_camel_case_types)]
#![allow(
clippy::cognitive_complexity,

View File

@ -1,3 +1,5 @@
#![allow(missing_docs)]
use core::marker::{PhantomData, PhantomPinned};
use core::mem;

View File

@ -1,3 +1,5 @@
#![allow(missing_docs)]
use crate::exception::Exception;
use alloc::boxed::Box;
use alloc::string::{String, ToString};

View File

@ -1,3 +1,5 @@
#![allow(missing_docs)]
use core::mem::{self, MaybeUninit};
use core::ptr::{self, NonNull};
use core::slice;

View File

@ -1,3 +1,5 @@
#![allow(missing_docs)]
use core::mem::{self, MaybeUninit};
use core::ptr::NonNull;
use core::str;

View File

@ -1,3 +1,5 @@
#![allow(missing_docs)]
use alloc::string::String;
use core::mem::{self, MaybeUninit};
use core::ptr;

View File

@ -1,3 +1,5 @@
#![allow(missing_docs)]
pub unsafe trait RustType {}
pub unsafe trait ImplBox {}
pub unsafe trait ImplVec {}

View File

@ -1,3 +1,5 @@
#![allow(missing_docs)]
use crate::rust_string::RustString;
use alloc::string::String;
use alloc::vec::Vec;

View File

@ -1,3 +1,5 @@
#![allow(missing_docs)]
use std::io::{self, Write};
use std::panic::{self, AssertUnwindSafe};
use std::process;

View File

@ -93,6 +93,7 @@ where
// Methods are private; not intended to be implemented outside of cxxbridge
// codebase.
#[allow(missing_docs)]
pub unsafe trait WeakPtrTarget {
#[doc(hidden)]
fn __typename(f: &mut fmt::Formatter) -> fmt::Result;