src/test/ui/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 error: unused doc comment
  31   --> $DIR/useless-comment.rs:16:5
  32    |
  33 LL | /     /// multi-line
  34 LL | |     /// doc comment
  35 LL | |     /// that is unused
  36    | |______________________^
  37 LL | /     match x {
  38 LL | |         /// c
  39 LL | |         1 => {},
  40 LL | |         _ => {}
  41 LL | |     }
  42    | |_____- rustdoc does not generate documentation for expressions
  43
  44 error: unused doc comment
  45   --> $DIR/useless-comment.rs:20:9
  46    |
  47 LL |         /// c
  48    |         ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  49 LL |         1 => {},
  50    |         ------- rustdoc does not generate documentation for match arms
  51
  52 error: unused doc comment
  53   --> $DIR/useless-comment.rs:25:5
  54    |
  55 LL |     /// foo
  56    |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  57 LL |     unsafe {}
  58    |     --------- rustdoc does not generate documentation for expressions
  59
  60 error: unused doc comment
  61   --> $DIR/useless-comment.rs:28:5
  62    |
  63 LL |     #[doc = "foo"]
  64    |     ^^^^^^^^^^^^^^
  65 LL |     #[doc = "bar"]
  66 LL |     3;
  67    |     - rustdoc does not generate documentation for expressions
  68
  69 error: unused doc comment
  70   --> $DIR/useless-comment.rs:29:5
  71    |
  72 LL |     #[doc = "bar"]
  73    |     ^^^^^^^^^^^^^^
  74 LL |     3;
  75    |     - rustdoc does not generate documentation for expressions
  76
  77 error: unused doc comment
  78   --> $DIR/useless-comment.rs:35:13
  79    |
  80 LL |     let x = /** comment */ 47;
  81    |             ^^^^^^^^^^^^^^ -- rustdoc does not generate documentation for expressions
  82
  83 error: unused doc comment
  84   --> $DIR/useless-comment.rs:37:5
  85    |
  86 LL |       /// dox
  87    |       ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  88 LL | /     {
  89 LL | |
  90 LL | |     }
  91    | |_____- rustdoc does not generate documentation for expressions
  92
  93 error: aborting due to 10 previous errors
  94