79203653d1
global_asm! items cannot be documented, the lint still gets triggered after adding documentation to the macro invocation. Furthermore, even if we could add documentation to the AST node, rustdoc doesn't render it anyways. Playground example: https://play.rust-lang.org/?version=nightly&mode=debug&edition=2018&gist=5182df182f0ffbbab4c3107e43368ac3
182 lines
3.2 KiB
Rust
182 lines
3.2 KiB
Rust
#![warn(clippy::missing_docs_in_private_items)]
|
|
// When denying at the crate level, be sure to not get random warnings from the
|
|
// injected intrinsics by the compiler.
|
|
#![allow(dead_code)]
|
|
#![feature(associated_type_defaults, global_asm)]
|
|
|
|
//! Some garbage docs for the crate here
|
|
#![doc = "More garbage"]
|
|
|
|
type Typedef = String;
|
|
pub type PubTypedef = String;
|
|
|
|
struct Foo {
|
|
a: isize,
|
|
b: isize,
|
|
}
|
|
|
|
pub struct PubFoo {
|
|
pub a: isize,
|
|
b: isize,
|
|
}
|
|
|
|
#[allow(clippy::missing_docs_in_private_items)]
|
|
pub struct PubFoo2 {
|
|
pub a: isize,
|
|
pub c: isize,
|
|
}
|
|
|
|
mod module_no_dox {}
|
|
pub mod pub_module_no_dox {}
|
|
|
|
/// dox
|
|
pub fn foo() {}
|
|
pub fn foo2() {}
|
|
fn foo3() {}
|
|
#[allow(clippy::missing_docs_in_private_items)]
|
|
pub fn foo4() {}
|
|
|
|
/// dox
|
|
pub trait A {
|
|
/// dox
|
|
fn foo(&self);
|
|
/// dox
|
|
fn foo_with_impl(&self) {}
|
|
}
|
|
|
|
#[allow(clippy::missing_docs_in_private_items)]
|
|
trait B {
|
|
fn foo(&self);
|
|
fn foo_with_impl(&self) {}
|
|
}
|
|
|
|
pub trait C {
|
|
fn foo(&self);
|
|
fn foo_with_impl(&self) {}
|
|
}
|
|
|
|
#[allow(clippy::missing_docs_in_private_items)]
|
|
pub trait D {
|
|
fn dummy(&self) {}
|
|
}
|
|
|
|
/// dox
|
|
pub trait E {
|
|
type AssociatedType;
|
|
type AssociatedTypeDef = Self;
|
|
|
|
/// dox
|
|
type DocumentedType;
|
|
/// dox
|
|
type DocumentedTypeDef = Self;
|
|
/// dox
|
|
fn dummy(&self) {}
|
|
}
|
|
|
|
impl Foo {
|
|
pub fn foo() {}
|
|
fn bar() {}
|
|
}
|
|
|
|
impl PubFoo {
|
|
pub fn foo() {}
|
|
/// dox
|
|
pub fn foo1() {}
|
|
fn foo2() {}
|
|
#[allow(clippy::missing_docs_in_private_items)]
|
|
pub fn foo3() {}
|
|
}
|
|
|
|
#[allow(clippy::missing_docs_in_private_items)]
|
|
trait F {
|
|
fn a();
|
|
fn b(&self);
|
|
}
|
|
|
|
// should need to redefine documentation for implementations of traits
|
|
impl F for Foo {
|
|
fn a() {}
|
|
fn b(&self) {}
|
|
}
|
|
|
|
// It sure is nice if doc(hidden) implies allow(missing_docs), and that it
|
|
// applies recursively
|
|
#[doc(hidden)]
|
|
mod a {
|
|
pub fn baz() {}
|
|
pub mod b {
|
|
pub fn baz() {}
|
|
}
|
|
}
|
|
|
|
enum Baz {
|
|
BazA { a: isize, b: isize },
|
|
BarB,
|
|
}
|
|
|
|
pub enum PubBaz {
|
|
PubBazA { a: isize },
|
|
}
|
|
|
|
/// dox
|
|
pub enum PubBaz2 {
|
|
/// dox
|
|
PubBaz2A {
|
|
/// dox
|
|
a: isize,
|
|
},
|
|
}
|
|
|
|
#[allow(clippy::missing_docs_in_private_items)]
|
|
pub enum PubBaz3 {
|
|
PubBaz3A { b: isize },
|
|
}
|
|
|
|
#[doc(hidden)]
|
|
pub fn baz() {}
|
|
|
|
const FOO: u32 = 0;
|
|
/// dox
|
|
pub const FOO1: u32 = 0;
|
|
#[allow(clippy::missing_docs_in_private_items)]
|
|
pub const FOO2: u32 = 0;
|
|
#[doc(hidden)]
|
|
pub const FOO3: u32 = 0;
|
|
pub const FOO4: u32 = 0;
|
|
|
|
static BAR: u32 = 0;
|
|
/// dox
|
|
pub static BAR1: u32 = 0;
|
|
#[allow(clippy::missing_docs_in_private_items)]
|
|
pub static BAR2: u32 = 0;
|
|
#[doc(hidden)]
|
|
pub static BAR3: u32 = 0;
|
|
pub static BAR4: u32 = 0;
|
|
|
|
mod internal_impl {
|
|
/// dox
|
|
pub fn documented() {}
|
|
pub fn undocumented1() {}
|
|
pub fn undocumented2() {}
|
|
fn undocumented3() {}
|
|
/// dox
|
|
pub mod globbed {
|
|
/// dox
|
|
pub fn also_documented() {}
|
|
pub fn also_undocumented1() {}
|
|
fn also_undocumented2() {}
|
|
}
|
|
}
|
|
/// dox
|
|
pub mod public_interface {
|
|
pub use internal_impl::documented as foo;
|
|
pub use internal_impl::globbed::*;
|
|
pub use internal_impl::undocumented1 as bar;
|
|
pub use internal_impl::{documented, undocumented2};
|
|
}
|
|
|
|
fn main() {}
|
|
|
|
// Ensure global asm doesn't require documentation.
|
|
global_asm! { "" }
|