about summary refs log tree commit diff
path: root/src/tools/clippy/tests/ui/suspicious_doc_comments.stderr
blob: df04d08537c9101f6a0ace6772a9fbab9fbb8cb8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
error: this is an outer doc comment and does not apply to the parent module or crate
  --> tests/ui/suspicious_doc_comments.rs:6:1
   |
LL | ///! Fake module documentation.
   | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
   |
   = note: `-D clippy::suspicious-doc-comments` implied by `-D warnings`
   = help: to override `-D warnings` add `#[allow(clippy::suspicious_doc_comments)]`
help: use an inner doc comment to document the parent module or crate
   |
LL - ///! Fake module documentation.
LL + //! Fake module documentation.
   |

error: this is an outer doc comment and does not apply to the parent module or crate
  --> tests/ui/suspicious_doc_comments.rs:11:5
   |
LL |     ///! This module contains useful functions.
   |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
   |
help: use an inner doc comment to document the parent module or crate
   |
LL -     ///! This module contains useful functions.
LL +     //! This module contains useful functions.
   |

error: this is an outer doc comment and does not apply to the parent module or crate
  --> tests/ui/suspicious_doc_comments.rs:24:5
   |
LL | /     /**! This module contains useful functions.
LL | |      */
   | |_______^
   |
help: use an inner doc comment to document the parent module or crate
   |
LL ~     /*! This module contains useful functions.
LL +      */
   |

error: this is an outer doc comment and does not apply to the parent module or crate
  --> tests/ui/suspicious_doc_comments.rs:39:5
   |
LL | /     ///! This module
LL | |
LL | |     ///! contains
LL | |     ///! useful functions.
   | |__________________________^
   |
help: use an inner doc comment to document the parent module or crate
   |
LL ~     //! This module
LL |
LL ~     //! contains
LL ~     //! useful functions.
   |

error: this is an outer doc comment and does not apply to the parent module or crate
  --> tests/ui/suspicious_doc_comments.rs:48:5
   |
LL | /     ///! a
LL | |
LL | |     ///! b
   | |__________^
   |
help: use an inner doc comment to document the parent module or crate
   |
LL ~     //! a
LL |
LL ~     //! b
   |

error: this is an outer doc comment and does not apply to the parent module or crate
  --> tests/ui/suspicious_doc_comments.rs:57:5
   |
LL |     ///! a
   |     ^^^^^^
   |
help: use an inner doc comment to document the parent module or crate
   |
LL -     ///! a
LL +     //! a
   |

error: this is an outer doc comment and does not apply to the parent module or crate
  --> tests/ui/suspicious_doc_comments.rs:64:5
   |
LL | /     ///! a
...  |
LL | |     ///! b
   | |__________^
   |
help: use an inner doc comment to document the parent module or crate
   |
LL ~     //! a
LL |
LL |
LL ~     //! b
   |

error: this is an outer doc comment and does not apply to the parent module or crate
  --> tests/ui/suspicious_doc_comments.rs:77:5
   |
LL |     ///! Very cool macro
   |     ^^^^^^^^^^^^^^^^^^^^
   |
help: use an inner doc comment to document the parent module or crate
   |
LL -     ///! Very cool macro
LL +     //! Very cool macro
   |

error: this is an outer doc comment and does not apply to the parent module or crate
  --> tests/ui/suspicious_doc_comments.rs:85:5
   |
LL |     ///! Huh.
   |     ^^^^^^^^^
   |
help: use an inner doc comment to document the parent module or crate
   |
LL -     ///! Huh.
LL +     //! Huh.
   |

error: aborting due to 9 previous errors