clippy_tests/examples/missing-doc.stderr

   1 error: missing documentation for a type alias
   2   --> missing-doc.rs:26:1
   3    |
   4 26 | type Typedef = String;
   5    | ^^^^^^^^^^^^^^^^^^^^^^
   6    |
   7    = note: `-D missing-docs-in-private-items` implied by `-D warnings`
   8
   9 error: missing documentation for a type alias
  10   --> missing-doc.rs:27:1
  11    |
  12 27 | pub type PubTypedef = String;
  13    | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  14    |
  15    = note: `-D missing-docs-in-private-items` implied by `-D warnings`
  16
  17 error: missing documentation for a struct
  18   --> missing-doc.rs:29:1
  19    |
  20 29 | / struct Foo {
  21 30 | |     a: isize,
  22 31 | |     b: isize,
  23 32 | | }
  24    | |_^
  25    |
  26    = note: `-D missing-docs-in-private-items` implied by `-D warnings`
  27
  28 error: missing documentation for a struct field
  29   --> missing-doc.rs:30:5
  30    |
  31 30 |     a: isize,
  32    |     ^^^^^^^^
  33    |
  34    = note: `-D missing-docs-in-private-items` implied by `-D warnings`
  35
  36 error: missing documentation for a struct field
  37   --> missing-doc.rs:31:5
  38    |
  39 31 |     b: isize,
  40    |     ^^^^^^^^
  41    |
  42    = note: `-D missing-docs-in-private-items` implied by `-D warnings`
  43
  44 error: missing documentation for a struct
  45   --> missing-doc.rs:34:1
  46    |
  47 34 | / pub struct PubFoo {
  48 35 | |     pub a: isize,
  49 36 | |     b: isize,
  50 37 | | }
  51    | |_^
  52    |
  53    = note: `-D missing-docs-in-private-items` implied by `-D warnings`
  54
  55 error: missing documentation for a struct field
  56   --> missing-doc.rs:35:5
  57    |
  58 35 |     pub a: isize,
  59    |     ^^^^^^^^^^^^
  60    |
  61    = note: `-D missing-docs-in-private-items` implied by `-D warnings`
  62
  63 error: missing documentation for a struct field
  64   --> missing-doc.rs:36:5
  65    |
  66 36 |     b: isize,
  67    |     ^^^^^^^^
  68    |
  69    = note: `-D missing-docs-in-private-items` implied by `-D warnings`
  70
  71 error: missing documentation for a module
  72   --> missing-doc.rs:45:1
  73    |
  74 45 | mod module_no_dox {}
  75    | ^^^^^^^^^^^^^^^^^^^^
  76    |
  77    = note: `-D missing-docs-in-private-items` implied by `-D warnings`
  78
  79 error: missing documentation for a module
  80   --> missing-doc.rs:46:1
  81    |
  82 46 | pub mod pub_module_no_dox {}
  83    | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  84    |
  85    = note: `-D missing-docs-in-private-items` implied by `-D warnings`
  86
  87 error: missing documentation for a function
  88   --> missing-doc.rs:50:1
  89    |
  90 50 | pub fn foo2() {}
  91    | ^^^^^^^^^^^^^^^^
  92    |
  93    = note: `-D missing-docs-in-private-items` implied by `-D warnings`
  94
  95 error: missing documentation for a function
  96   --> missing-doc.rs:51:1
  97    |
  98 51 | fn foo3() {}
  99    | ^^^^^^^^^^^^
 100    |
 101    = note: `-D missing-docs-in-private-items` implied by `-D warnings`
 102
 103 error: missing documentation for a trait
 104   --> missing-doc.rs:68:1
 105    |
 106 68 | / pub trait C {
 107 69 | |     fn foo(&self);
 108 70 | |     fn foo_with_impl(&self) {}
 109 71 | | }
 110    | |_^
 111    |
 112    = note: `-D missing-docs-in-private-items` implied by `-D warnings`
 113
 114 error: missing documentation for a trait method
 115   --> missing-doc.rs:69:5
 116    |
 117 69 |     fn foo(&self);
 118    |     ^^^^^^^^^^^^^^
 119    |
 120    = note: `-D missing-docs-in-private-items` implied by `-D warnings`
 121
 122 error: missing documentation for a trait method
 123   --> missing-doc.rs:70:5
 124    |
 125 70 |     fn foo_with_impl(&self) {}
 126    |     ^^^^^^^^^^^^^^^^^^^^^^^^^^
 127    |
 128    = note: `-D missing-docs-in-private-items` implied by `-D warnings`
 129
 130 error: missing documentation for an associated type
 131   --> missing-doc.rs:80:5
 132    |
 133 80 |     type AssociatedType;
 134    |     ^^^^^^^^^^^^^^^^^^^^
 135    |
 136    = note: `-D missing-docs-in-private-items` implied by `-D warnings`
 137
 138 error: missing documentation for an associated type
 139   --> missing-doc.rs:81:5
 140    |
 141 81 |     type AssociatedTypeDef = Self;
 142    |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 143    |
 144    = note: `-D missing-docs-in-private-items` implied by `-D warnings`
 145
 146 error: missing documentation for a method
 147   --> missing-doc.rs:92:5
 148    |
 149 92 |     pub fn foo() {}
 150    |     ^^^^^^^^^^^^^^^
 151    |
 152    = note: `-D missing-docs-in-private-items` implied by `-D warnings`
 153
 154 error: missing documentation for a method
 155   --> missing-doc.rs:93:5
 156    |
 157 93 |     fn bar() {}
 158    |     ^^^^^^^^^^^
 159    |
 160    = note: `-D missing-docs-in-private-items` implied by `-D warnings`
 161
 162 error: missing documentation for a method
 163   --> missing-doc.rs:97:5
 164    |
 165 97 |     pub fn foo() {}
 166    |     ^^^^^^^^^^^^^^^
 167    |
 168    = note: `-D missing-docs-in-private-items` implied by `-D warnings`
 169
 170 error: missing documentation for a method
 171    --> missing-doc.rs:100:5
 172     |
 173 100 |     fn foo2() {}
 174     |     ^^^^^^^^^^^^
 175     |
 176     = note: `-D missing-docs-in-private-items` implied by `-D warnings`
 177
 178 error: missing documentation for an enum
 179    --> missing-doc.rs:126:1
 180     |
 181 126 | / enum Baz {
 182 127 | |     BazA {
 183 128 | |         a: isize,
 184 129 | |         b: isize
 185 130 | |     },
 186 131 | |     BarB
 187 132 | | }
 188     | |_^
 189     |
 190     = note: `-D missing-docs-in-private-items` implied by `-D warnings`
 191
 192 error: missing documentation for a variant
 193    --> missing-doc.rs:127:5
 194     |
 195 127 | /     BazA {
 196 128 | |         a: isize,
 197 129 | |         b: isize
 198 130 | |     },
 199     | |_____^
 200     |
 201     = note: `-D missing-docs-in-private-items` implied by `-D warnings`
 202
 203 error: missing documentation for a struct field
 204    --> missing-doc.rs:128:9
 205     |
 206 128 |         a: isize,
 207     |         ^^^^^^^^
 208     |
 209     = note: `-D missing-docs-in-private-items` implied by `-D warnings`
 210
 211 error: missing documentation for a struct field
 212    --> missing-doc.rs:129:9
 213     |
 214 129 |         b: isize
 215     |         ^^^^^^^^
 216     |
 217     = note: `-D missing-docs-in-private-items` implied by `-D warnings`
 218
 219 error: missing documentation for a variant
 220    --> missing-doc.rs:131:5
 221     |
 222 131 |     BarB
 223     |     ^^^^
 224     |
 225     = note: `-D missing-docs-in-private-items` implied by `-D warnings`
 226
 227 error: missing documentation for an enum
 228    --> missing-doc.rs:134:1
 229     |
 230 134 | / pub enum PubBaz {
 231 135 | |     PubBazA {
 232 136 | |         a: isize,
 233 137 | |     },
 234 138 | | }
 235     | |_^
 236     |
 237     = note: `-D missing-docs-in-private-items` implied by `-D warnings`
 238
 239 error: missing documentation for a variant
 240    --> missing-doc.rs:135:5
 241     |
 242 135 | /     PubBazA {
 243 136 | |         a: isize,
 244 137 | |     },
 245     | |_____^
 246     |
 247     = note: `-D missing-docs-in-private-items` implied by `-D warnings`
 248
 249 error: missing documentation for a struct field
 250    --> missing-doc.rs:136:9
 251     |
 252 136 |         a: isize,
 253     |         ^^^^^^^^
 254     |
 255     = note: `-D missing-docs-in-private-items` implied by `-D warnings`
 256
 257 error: missing documentation for a constant
 258    --> missing-doc.rs:160:1
 259     |
 260 160 | const FOO: u32 = 0;
 261     | ^^^^^^^^^^^^^^^^^^^
 262     |
 263     = note: `-D missing-docs-in-private-items` implied by `-D warnings`
 264
 265 error: missing documentation for a constant
 266    --> missing-doc.rs:167:1
 267     |
 268 167 | pub const FOO4: u32 = 0;
 269     | ^^^^^^^^^^^^^^^^^^^^^^^^
 270     |
 271     = note: `-D missing-docs-in-private-items` implied by `-D warnings`
 272
 273 error: missing documentation for a static
 274    --> missing-doc.rs:170:1
 275     |
 276 170 | static BAR: u32 = 0;
 277     | ^^^^^^^^^^^^^^^^^^^^
 278     |
 279     = note: `-D missing-docs-in-private-items` implied by `-D warnings`
 280
 281 error: missing documentation for a static
 282    --> missing-doc.rs:177:1
 283     |
 284 177 | pub static BAR4: u32 = 0;
 285     | ^^^^^^^^^^^^^^^^^^^^^^^^^
 286     |
 287     = note: `-D missing-docs-in-private-items` implied by `-D warnings`
 288
 289 error: missing documentation for a module
 290    --> missing-doc.rs:180:1
 291     |
 292 180 | / mod internal_impl {
 293 181 | |     /// dox
 294 182 | |     pub fn documented() {}
 295 183 | |     pub fn undocumented1() {}
 296 ...   |
 297 192 | |     }
 298 193 | | }
 299     | |_^
 300     |
 301     = note: `-D missing-docs-in-private-items` implied by `-D warnings`
 302
 303 error: missing documentation for a function
 304    --> missing-doc.rs:183:5
 305     |
 306 183 |     pub fn undocumented1() {}
 307     |     ^^^^^^^^^^^^^^^^^^^^^^^^^
 308     |
 309     = note: `-D missing-docs-in-private-items` implied by `-D warnings`
 310
 311 error: missing documentation for a function
 312    --> missing-doc.rs:184:5
 313     |
 314 184 |     pub fn undocumented2() {}
 315     |     ^^^^^^^^^^^^^^^^^^^^^^^^^
 316     |
 317     = note: `-D missing-docs-in-private-items` implied by `-D warnings`
 318
 319 error: missing documentation for a function
 320    --> missing-doc.rs:185:5
 321     |
 322 185 |     fn undocumented3() {}
 323     |     ^^^^^^^^^^^^^^^^^^^^^
 324     |
 325     = note: `-D missing-docs-in-private-items` implied by `-D warnings`
 326
 327 error: missing documentation for a function
 328    --> missing-doc.rs:190:9
 329     |
 330 190 |         pub fn also_undocumented1() {}
 331     |         ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 332     |
 333     = note: `-D missing-docs-in-private-items` implied by `-D warnings`
 334
 335 error: missing documentation for a function
 336    --> missing-doc.rs:191:9
 337     |
 338 191 |         fn also_undocumented2() {}
 339     |         ^^^^^^^^^^^^^^^^^^^^^^^^^^
 340     |
 341     = note: `-D missing-docs-in-private-items` implied by `-D warnings`
 342
 343 error: missing documentation for a function
 344    --> missing-doc.rs:202:1
 345     |
 346 202 | fn main() {}
 347     | ^^^^^^^^^^^^
 348     |
 349     = note: `-D missing-docs-in-private-items` implied by `-D warnings`
 350
 351 error: aborting due to previous error(s)
 352
 353
 354 To learn more, run the command again with --verbose.