W3cubDocs

/Rust

Error code E0585

A documentation comment that doesn't document anything was found.

Erroneous code example:

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:

#![allow(unused)]
fn main() {
/// I'm documenting the following struct:
struct Foo;

/// I'm documenting the following function:
fn foo() {}
}

© 2010 The Rust Project Developers
Licensed under the Apache License, Version 2.0 or the MIT license, at your option.
https://doc.rust-lang.org/error_codes/E0585.html