RustDoc not working on specific files

[alexispurslane]

BTW im fairly new to rust.
So, in parser.rs, I have this code:

mod tokenizer;
#[experimental = "Not finished"]
/// The parse funciton translates the tokens generated by the tokenizer into LLVM nodes.
///
/// The parser is both the most important and hardest item of the entire alonzo system. In it, we
/// translate Alnozo code into LLVM nodes, and than output the machene language that results.
/// Since LLVM is used for more C-like, lowlevel languages, translating Alnonzo to it will be very
/// hard, and sometimes it might look like this code came from "The Department of Redundancy
/// Department."
#[experimental = "Not finished"]
fn parse (tokens: Vec<tokenizer::Token>) /*-> SomeKindOfLLVMThing*/ {

}

Then, I run rustdoc src/parser.rs. I then look in the doc/ directory and see nothing pertaining to the parser. But when I run rustdoc on the tokenizer file, guess what, I see a directory with that name right there in the doc directory. Please help.

[steveklabnik]

It's not pub.

[tomjakubowski]

You can document private items by removing the strip-private pass (see rustdoc --passes list):

rustdoc --passes "strip-hidden collapse-docs unindent-comments" src/parser.rs

It's also generally a better idea to run rustdoc on your crate root, and not on individual modules.

[alexispurslane]

How do you do that? (run it on the crate root?) I have looked at the man rustdoc docs, and found nothing on that sort of thing. I was hoping there was a way to do that!

[steveklabnik]

rustdoc my_crate.rs

[steveklabnik]

Anyway, giving this a close, as this isn't a bug.