Что означает предупреждение "doc comment не используется rustdoc" и как мне это исправить?

Question

Следующий код выдает предупреждение при компиляции:

pub fn add_source_path(request: &mut Request) -> IronResult<Response> {
/// Adds source path to the database.
///
/// This function saves provided absolute path (on the server) to the database
/// and goes over all jpeg files recursively in order to add them to DB.

let params = request.get_ref::<Params>().unwrap();

let path = &params["path"];

Это предупреждение:

warning: doc comment not used by rustdoc
--> src/crawler.rs:64:2
   |
64 |  /// Adds source path to the database.
   |  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
   |
   = note: #[warn(unused_doc_comment)] on by default

Что именно означает это предупреждение и как его исправить?

Answer 1

Комментарии, начинающиеся с ///, используются для создания документации.Эти комментарии к документации идут перед функцией, которую они документируют.Цитирование Язык программирования Rust :

Размещайте комментарии к документации непосредственно перед документом, который они документируют.

/// Adds source path to the database.
///
/// This function saves provided absolute path (on the server) to the database
/// and goes over all jpeg files recursively in order to add them to DB.
pub fn add_source_path(request: &mut Request) -> IronResult<Response> {
    // ...
}