diff options
Diffstat (limited to 'compiler/rustc_error_codes/src/error_codes/E0585.md')
-rw-r--r-- | compiler/rustc_error_codes/src/error_codes/E0585.md | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/compiler/rustc_error_codes/src/error_codes/E0585.md b/compiler/rustc_error_codes/src/error_codes/E0585.md new file mode 100644 index 000000000..de27cc19d --- /dev/null +++ b/compiler/rustc_error_codes/src/error_codes/E0585.md @@ -0,0 +1,21 @@ +A documentation comment that doesn't document anything was found. + +Erroneous code example: + +```compile_fail,E0585 +fn main() { + // The following doc comment will fail: + /// This is a useless doc comment! +} +``` + +Documentation comments need to be followed by items, including functions, +types, modules, etc. Examples: + +``` +/// I'm documenting the following struct: +struct Foo; + +/// I'm documenting the following function: +fn foo() {} +``` |