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

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 не поддерживал флаг.