-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Auto merge of #5030 - JohnTitor:split-missing-doc, r=phansch
Split up `missing-doc` ui test Part of #2038 changelog: none
- Loading branch information
Showing
4 changed files
with
214 additions
and
202 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,87 @@ | ||
#![warn(clippy::missing_docs_in_private_items)] | ||
#![allow(dead_code)] | ||
#![feature(associated_type_defaults)] | ||
|
||
//! Some garbage docs for the crate here | ||
#![doc = "More garbage"] | ||
|
||
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, | ||
} | ||
|
||
/// 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) {} | ||
} | ||
|
||
fn main() {} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,103 @@ | ||
error: missing documentation for a struct | ||
--> $DIR/missing-doc-impl.rs:8:1 | ||
| | ||
LL | / struct Foo { | ||
LL | | a: isize, | ||
LL | | b: isize, | ||
LL | | } | ||
| |_^ | ||
| | ||
= note: `-D clippy::missing-docs-in-private-items` implied by `-D warnings` | ||
|
||
error: missing documentation for a struct field | ||
--> $DIR/missing-doc-impl.rs:9:5 | ||
| | ||
LL | a: isize, | ||
| ^^^^^^^^ | ||
|
||
error: missing documentation for a struct field | ||
--> $DIR/missing-doc-impl.rs:10:5 | ||
| | ||
LL | b: isize, | ||
| ^^^^^^^^ | ||
|
||
error: missing documentation for a struct | ||
--> $DIR/missing-doc-impl.rs:13:1 | ||
| | ||
LL | / pub struct PubFoo { | ||
LL | | pub a: isize, | ||
LL | | b: isize, | ||
LL | | } | ||
| |_^ | ||
|
||
error: missing documentation for a struct field | ||
--> $DIR/missing-doc-impl.rs:14:5 | ||
| | ||
LL | pub a: isize, | ||
| ^^^^^^^^^^^^ | ||
|
||
error: missing documentation for a struct field | ||
--> $DIR/missing-doc-impl.rs:15:5 | ||
| | ||
LL | b: isize, | ||
| ^^^^^^^^ | ||
|
||
error: missing documentation for a trait | ||
--> $DIR/missing-doc-impl.rs:38:1 | ||
| | ||
LL | / pub trait C { | ||
LL | | fn foo(&self); | ||
LL | | fn foo_with_impl(&self) {} | ||
LL | | } | ||
| |_^ | ||
|
||
error: missing documentation for a trait method | ||
--> $DIR/missing-doc-impl.rs:39:5 | ||
| | ||
LL | fn foo(&self); | ||
| ^^^^^^^^^^^^^^ | ||
|
||
error: missing documentation for a trait method | ||
--> $DIR/missing-doc-impl.rs:40:5 | ||
| | ||
LL | fn foo_with_impl(&self) {} | ||
| ^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
|
||
error: missing documentation for an associated type | ||
--> $DIR/missing-doc-impl.rs:50:5 | ||
| | ||
LL | type AssociatedType; | ||
| ^^^^^^^^^^^^^^^^^^^^ | ||
|
||
error: missing documentation for an associated type | ||
--> $DIR/missing-doc-impl.rs:51:5 | ||
| | ||
LL | type AssociatedTypeDef = Self; | ||
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
|
||
error: missing documentation for a method | ||
--> $DIR/missing-doc-impl.rs:62:5 | ||
| | ||
LL | pub fn foo() {} | ||
| ^^^^^^^^^^^^^^^ | ||
|
||
error: missing documentation for a method | ||
--> $DIR/missing-doc-impl.rs:63:5 | ||
| | ||
LL | fn bar() {} | ||
| ^^^^^^^^^^^ | ||
|
||
error: missing documentation for a method | ||
--> $DIR/missing-doc-impl.rs:67:5 | ||
| | ||
LL | pub fn foo() {} | ||
| ^^^^^^^^^^^^^^^ | ||
|
||
error: missing documentation for a method | ||
--> $DIR/missing-doc-impl.rs:70:5 | ||
| | ||
LL | fn foo2() {} | ||
| ^^^^^^^^^^^^ | ||
|
||
error: aborting due to 15 previous errors | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.