src/test/ui/useless-comment.stderr

   1 error: unused doc comment
   2   --> $DIR/useless-comment.rs:9:1
   3    |
   4 LL | /// foo
   5    | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
   6 LL | mac!();
   7    | ------- rustdoc does not generate documentation for macro expansions
   8    |
   9 note: lint level defined here
  10   --> $DIR/useless-comment.rs:3:9
  11    |
  12 LL | #![deny(unused_doc_comments)]
  13    |         ^^^^^^^^^^^^^^^^^^^
  14    = help: to document an item produced by a macro, the macro must produce the documentation as part of its expansion
  15
  16 error: unused doc comment
  17   --> $DIR/useless-comment.rs:13:5
  18    |
  19 LL |     /// a
  20    |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  21 LL |     let x = 12;
  22    |     ----------- rustdoc does not generate documentation for statements
  23
  24 error: unused doc comment
  25   --> $DIR/useless-comment.rs:16:5
  26    |
  27 LL | /     /// multi-line
  28 LL | |     /// doc comment
  29 LL | |     /// that is unused
  30    | |______________________^
  31 LL | /     match x {
  32 LL | |         /// c
  33 LL | |         1 => {},
  34 LL | |         _ => {}
  35 LL | |     }
  36    | |_____- rustdoc does not generate documentation for expressions
  37
  38 error: unused doc comment
  39   --> $DIR/useless-comment.rs:20:9
  40    |
  41 LL |         /// c
  42    |         ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  43 LL |         1 => {},
  44    |         ------- rustdoc does not generate documentation for match arms
  45
  46 error: unused doc comment
  47   --> $DIR/useless-comment.rs:25:5
  48    |
  49 LL |     /// foo
  50    |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  51 LL |     unsafe {}
  52    |     --------- rustdoc does not generate documentation for expressions
  53
  54 error: unused doc comment
  55   --> $DIR/useless-comment.rs:28:5
  56    |
  57 LL |     #[doc = "foo"]
  58    |     ^^^^^^^^^^^^^^
  59 LL |     #[doc = "bar"]
  60 LL |     3;
  61    |     - rustdoc does not generate documentation for expressions
  62
  63 error: unused doc comment
  64   --> $DIR/useless-comment.rs:29:5
  65    |
  66 LL |     #[doc = "bar"]
  67    |     ^^^^^^^^^^^^^^
  68 LL |     3;
  69    |     - rustdoc does not generate documentation for expressions
  70
  71 error: unused doc comment
  72   --> $DIR/useless-comment.rs:32:5
  73    |
  74 LL |     /// bar
  75    |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  76 LL |     mac!();
  77    |     ------- rustdoc does not generate documentation for macro expansions
  78    |
  79    = help: to document an item produced by a macro, the macro must produce the documentation as part of its expansion
  80
  81 error: unused doc comment
  82   --> $DIR/useless-comment.rs:35:13
  83    |
  84 LL |     let x = /** comment */ 47;
  85    |             ^^^^^^^^^^^^^^ -- rustdoc does not generate documentation for expressions
  86
  87 error: unused doc comment
  88   --> $DIR/useless-comment.rs:37:5
  89    |
  90 LL |       /// dox
  91    |       ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  92 LL | /     {
  93 LL | |
  94 LL | |     }
  95    | |_____- rustdoc does not generate documentation for expressions
  96
  97 error: aborting due to 10 previous errors
  98