Correctly generating Rustdocs

Asked Nov 15 '19 at 06:24

Active Nov 15 '19 at 06:56

Viewed 45 times

I'm probably missing something incredibly obvious, but I'm having trouble generating documentation for my code. I'm reading this tutorial and from what I understand, I can simply do something like

/// this is a doc comment
pub fn something() {

}

and run cargo doc --no-deps --open to get my crate's html page. However, my index.html is just showing the crate name and nothing else.

I have the following structure:

src/
  | main.rs
  | random_file.rs
  | drivers/
    | mod.rs 
    | foo.rs 
    | dummy.rs

and in my foo.rs I have

/// in foo doc
pub fn bar() {

}

What am I missing?

edited Nov 15 '19 at 06:56

asked Nov 15 '19 at 06:24

Ayumu Kasugano

Try making the function public for a quick fix, if you really want it private, have a look at this: https://stackoverflow.com/questions/29378113/how-can-i-include-private-modules-when-generating-documentation-via-cargo – 8176135 Nov 15 '19 at 06:44
@Prime_Aqasix apologies, the function is public – Ayumu Kasugano Nov 15 '19 at 06:55
1

Does `main.rs` declare `mod drivers` public? does drivers/mod.rs declare `mod foo` public? – Po' Lazarus Nov 15 '19 at 07:34
D'oh! That's it! – Ayumu Kasugano Nov 15 '19 at 07:36

Correctly generating Rustdocs

0 Answers0