src/test/ui/lint/unused/useless-comment.stderr

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