Как создать документацию для личных вещей

Question

У меня есть проект с:

main.rs
module_1/mod.rs
module_2/mod.rs
module_2/module_3/mod.rs

когда я бегу cargo docУ меня есть только документация для main.rs, не для модулей.

В моем main.rs Я имею:

mod module_1;
mod module_2;

fn main() {
...
}

Я пытался документировать модули с помощью /// или же //!,

Я не могу найти в rustdocпомогите как это сделать.

Кто-нибудь может мне объяснить?

Answer 1

Это связано с тем, что эти модули являются закрытыми, а поведение по умолчанию заключается в документировании только открытых членов.

По состоянию на Rust 1.29.0, cargo doc опоры --document-private-items, чтобы документировать личные вещи.

До 1.29, rustdoc уже поддерживает флаг --document-private-itemsЭто означает, что вы можете создать документацию для вашего проекта, используя cargo rustdoc -- --document-private-items, Но cargo doc не поддерживал флаг.