diff options
| author | bors <bors@rust-lang.org> | 2020-04-22 11:14:23 +0000 |
|---|---|---|
| committer | bors <bors@rust-lang.org> | 2020-04-22 11:14:23 +0000 |
| commit | 00f677d8974b393ff32ca25bf916b6b9650c75b0 (patch) | |
| tree | dfb7add749b25b2d432a93586814b00a28c45cfb /src/librustc_error_codes/error_codes | |
| parent | 4bfd62acb12a5e628d28950f9f94c3499216f10c (diff) | |
| parent | 01fdc885d6bd5ee9651fce930cc10d05dc274988 (diff) | |
| download | rust-00f677d8974b393ff32ca25bf916b6b9650c75b0.tar.gz rust-00f677d8974b393ff32ca25bf916b6b9650c75b0.zip | |
Auto merge of #71424 - Dylan-DPC:rollup-iunh61a, r=Dylan-DPC
Rollup of 6 pull requests Successful merges: - #70970 (Detect mistyped associated consts in `Instance::resolve`.) - #71203 (Correct await span for async-await error reporting) - #71214 (Add error code for inner doc error) - #71337 (Moving all rustdoc-ui tests to check-pass) - #71412 (Clarify unused_doc_comments note on macro invocations) - #71414 (More diagnostic items for Clippy usage) Failed merges: r? @ghost
Diffstat (limited to 'src/librustc_error_codes/error_codes')
| -rw-r--r-- | src/librustc_error_codes/error_codes/E0753.md | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/src/librustc_error_codes/error_codes/E0753.md b/src/librustc_error_codes/error_codes/E0753.md new file mode 100644 index 00000000000..a69da964aee --- /dev/null +++ b/src/librustc_error_codes/error_codes/E0753.md @@ -0,0 +1,31 @@ +An inner doc comment was used in an invalid context. + +Erroneous code example: + +```compile_fail,E0753 +fn foo() {} +//! foo +// ^ error! +fn main() {} +``` + +Inner document can only be used before items. For example: + +``` +//! A working comment applied to the module! +fn foo() { + //! Another working comment! +} +fn main() {} +``` + +In case you want to document the item following the doc comment, you might want +to use outer doc comment: + +``` +/// I am an outer doc comment +#[doc = "I am also an outer doc comment!"] +fn foo() { + // ... +} +``` |
