mirror of
https://github.com/rust-lang/rust-clippy
synced 2024-11-30 16:39:26 +00:00
38d4ac7cea
Discussion previously happened in https://github.com/rust-lang/rust/pull/43498
258 lines
5.7 KiB
Text
258 lines
5.7 KiB
Text
error: missing documentation for a type alias
|
|
--> $DIR/missing-doc.rs:10:1
|
|
|
|
|
LL | type Typedef = String;
|
|
| ^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
|
= note: `-D clippy::missing-docs-in-private-items` implied by `-D warnings`
|
|
|
|
error: missing documentation for a type alias
|
|
--> $DIR/missing-doc.rs:11:1
|
|
|
|
|
LL | pub type PubTypedef = String;
|
|
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
error: missing documentation for a struct
|
|
--> $DIR/missing-doc.rs:13:1
|
|
|
|
|
LL | / struct Foo {
|
|
LL | | a: isize,
|
|
LL | | b: isize,
|
|
LL | | }
|
|
| |_^
|
|
|
|
error: missing documentation for a struct field
|
|
--> $DIR/missing-doc.rs:14:5
|
|
|
|
|
LL | a: isize,
|
|
| ^^^^^^^^
|
|
|
|
error: missing documentation for a struct field
|
|
--> $DIR/missing-doc.rs:15:5
|
|
|
|
|
LL | b: isize,
|
|
| ^^^^^^^^
|
|
|
|
error: missing documentation for a struct
|
|
--> $DIR/missing-doc.rs:18:1
|
|
|
|
|
LL | / pub struct PubFoo {
|
|
LL | | pub a: isize,
|
|
LL | | b: isize,
|
|
LL | | }
|
|
| |_^
|
|
|
|
error: missing documentation for a struct field
|
|
--> $DIR/missing-doc.rs:19:5
|
|
|
|
|
LL | pub a: isize,
|
|
| ^^^^^^^^^^^^
|
|
|
|
error: missing documentation for a struct field
|
|
--> $DIR/missing-doc.rs:20:5
|
|
|
|
|
LL | b: isize,
|
|
| ^^^^^^^^
|
|
|
|
error: missing documentation for a module
|
|
--> $DIR/missing-doc.rs:29:1
|
|
|
|
|
LL | mod module_no_dox {}
|
|
| ^^^^^^^^^^^^^^^^^^^^
|
|
|
|
error: missing documentation for a module
|
|
--> $DIR/missing-doc.rs:30:1
|
|
|
|
|
LL | pub mod pub_module_no_dox {}
|
|
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
error: missing documentation for a function
|
|
--> $DIR/missing-doc.rs:34:1
|
|
|
|
|
LL | pub fn foo2() {}
|
|
| ^^^^^^^^^^^^^^^^
|
|
|
|
error: missing documentation for a function
|
|
--> $DIR/missing-doc.rs:35:1
|
|
|
|
|
LL | fn foo3() {}
|
|
| ^^^^^^^^^^^^
|
|
|
|
error: missing documentation for a trait
|
|
--> $DIR/missing-doc.rs:53: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.rs:54:5
|
|
|
|
|
LL | fn foo(&self);
|
|
| ^^^^^^^^^^^^^^
|
|
|
|
error: missing documentation for a trait method
|
|
--> $DIR/missing-doc.rs:55:5
|
|
|
|
|
LL | fn foo_with_impl(&self) {}
|
|
| ^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
error: missing documentation for an associated type
|
|
--> $DIR/missing-doc.rs:65:5
|
|
|
|
|
LL | type AssociatedType;
|
|
| ^^^^^^^^^^^^^^^^^^^^
|
|
|
|
error: missing documentation for an associated type
|
|
--> $DIR/missing-doc.rs:66:5
|
|
|
|
|
LL | type AssociatedTypeDef = Self;
|
|
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
error: missing documentation for a method
|
|
--> $DIR/missing-doc.rs:77:5
|
|
|
|
|
LL | pub fn foo() {}
|
|
| ^^^^^^^^^^^^^^^
|
|
|
|
error: missing documentation for a method
|
|
--> $DIR/missing-doc.rs:78:5
|
|
|
|
|
LL | fn bar() {}
|
|
| ^^^^^^^^^^^
|
|
|
|
error: missing documentation for a method
|
|
--> $DIR/missing-doc.rs:82:5
|
|
|
|
|
LL | pub fn foo() {}
|
|
| ^^^^^^^^^^^^^^^
|
|
|
|
error: missing documentation for a method
|
|
--> $DIR/missing-doc.rs:85:5
|
|
|
|
|
LL | fn foo2() {}
|
|
| ^^^^^^^^^^^^
|
|
|
|
error: missing documentation for an enum
|
|
--> $DIR/missing-doc.rs:112:1
|
|
|
|
|
LL | / enum Baz {
|
|
LL | | BazA { a: isize, b: isize },
|
|
LL | | BarB,
|
|
LL | | }
|
|
| |_^
|
|
|
|
error: missing documentation for a variant
|
|
--> $DIR/missing-doc.rs:113:5
|
|
|
|
|
LL | BazA { a: isize, b: isize },
|
|
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
error: missing documentation for a struct field
|
|
--> $DIR/missing-doc.rs:113:12
|
|
|
|
|
LL | BazA { a: isize, b: isize },
|
|
| ^^^^^^^^
|
|
|
|
error: missing documentation for a struct field
|
|
--> $DIR/missing-doc.rs:113:22
|
|
|
|
|
LL | BazA { a: isize, b: isize },
|
|
| ^^^^^^^^
|
|
|
|
error: missing documentation for a variant
|
|
--> $DIR/missing-doc.rs:114:5
|
|
|
|
|
LL | BarB,
|
|
| ^^^^
|
|
|
|
error: missing documentation for an enum
|
|
--> $DIR/missing-doc.rs:117:1
|
|
|
|
|
LL | / pub enum PubBaz {
|
|
LL | | PubBazA { a: isize },
|
|
LL | | }
|
|
| |_^
|
|
|
|
error: missing documentation for a variant
|
|
--> $DIR/missing-doc.rs:118:5
|
|
|
|
|
LL | PubBazA { a: isize },
|
|
| ^^^^^^^^^^^^^^^^^^^^
|
|
|
|
error: missing documentation for a struct field
|
|
--> $DIR/missing-doc.rs:118:15
|
|
|
|
|
LL | PubBazA { a: isize },
|
|
| ^^^^^^^^
|
|
|
|
error: missing documentation for a constant
|
|
--> $DIR/missing-doc.rs:138:1
|
|
|
|
|
LL | const FOO: u32 = 0;
|
|
| ^^^^^^^^^^^^^^^^^^^
|
|
|
|
error: missing documentation for a constant
|
|
--> $DIR/missing-doc.rs:145:1
|
|
|
|
|
LL | pub const FOO4: u32 = 0;
|
|
| ^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
error: missing documentation for a static
|
|
--> $DIR/missing-doc.rs:147:1
|
|
|
|
|
LL | static BAR: u32 = 0;
|
|
| ^^^^^^^^^^^^^^^^^^^^
|
|
|
|
error: missing documentation for a static
|
|
--> $DIR/missing-doc.rs:154:1
|
|
|
|
|
LL | pub static BAR4: u32 = 0;
|
|
| ^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
error: missing documentation for a module
|
|
--> $DIR/missing-doc.rs:156:1
|
|
|
|
|
LL | / mod internal_impl {
|
|
LL | | /// dox
|
|
LL | | pub fn documented() {}
|
|
LL | | pub fn undocumented1() {}
|
|
... |
|
|
LL | | }
|
|
LL | | }
|
|
| |_^
|
|
|
|
error: missing documentation for a function
|
|
--> $DIR/missing-doc.rs:159:5
|
|
|
|
|
LL | pub fn undocumented1() {}
|
|
| ^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
error: missing documentation for a function
|
|
--> $DIR/missing-doc.rs:160:5
|
|
|
|
|
LL | pub fn undocumented2() {}
|
|
| ^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
error: missing documentation for a function
|
|
--> $DIR/missing-doc.rs:161:5
|
|
|
|
|
LL | fn undocumented3() {}
|
|
| ^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
error: missing documentation for a function
|
|
--> $DIR/missing-doc.rs:166:9
|
|
|
|
|
LL | pub fn also_undocumented1() {}
|
|
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
error: missing documentation for a function
|
|
--> $DIR/missing-doc.rs:167:9
|
|
|
|
|
LL | fn also_undocumented2() {}
|
|
| ^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
error: aborting due to 39 previous errors
|
|
|