Rust: [rustdoc] Private macros are not documented with `--document-private-items`

Created on 26 Jun 2020  路  3Comments  路  Source: rust-lang/rust

Rustdoc has --document-private-items and --document-hidden-items. It would be nice to have an option to document non-exported macros, which is currently not possible as far as I can tell.

A-macros C-bug E-medium P-medium T-rustdoc
Source
picture TyPR124

Most helpful comment

I would expect --document-private-items to also document macros, so this seems like a bug

picture jonas-schievink on 26 Jun 2020
👍3

All 3 comments

I would expect --document-private-items to also document macros, so this seems like a bug

jonas-schievink picture jonas-schievink on 26 Jun 2020
👍3

This is because rustdoc gets macros from Crate.exported_macros, which doesn't have the private macros in the first place. Intra-doc links don't have this problem because they look at Resolver::all_macros. Maybe the rest of rustdoc could use that too?

jyn514 picture jyn514 on 11 Oct 2020

Marking as P-medium since this behavior is pretty confusing.

camelid picture camelid on 19 Oct 2020
Was this page helpful?
0 / 5 - 0 ratings

Related issues

modsec picture modsec  路  3Comments
tikue picture tikue  路  3Comments
nikomatsakis picture nikomatsakis  路  3Comments
dnsl48 picture dnsl48  路  3Comments
jmegaffin picture jmegaffin  路  3Comments