Modules§
- clean πThis module defines the primary IR used in rustdoc together with the procedures that transform rustc data types into it.
- config π
- core π
- docfs πRustdocβs FileSystem abstraction module.
- doctest π
- error π
- externalfiles π
- fold π
- formats π
- json πRustdocβs JSON backend
- lint π
- markdown πStandalone markdown rendering.
- passes πContains information about βpassesβ, used to modify crate information during the documentation process.
- scrape_
examples πThis module analyzes crates to find call sites that can serve as examples in the documentation. - theme π
- visit π
- visit_
ast πThe Rust AST Visitor. Extracts useful information and massages it into a form usable forclean
. - visit_
lib π
Macros§
- map πA macro to create a FxHashMap.
Functions§
- init_
logging π - main_
args π - opts π
- run_
merge_ πfinalize Renders and writes cross-crate info files, like the search index. This function exists so that we can run rustdoc without a crate root in the--merge=finalize
mode. Cross-crate info files discovered via--include-parts-dir
are combined and written to the doc root. - run_
renderer π - usage π
- wrap_
return π
Type Aliases§
- Main
Result πA result type used by several functions undermain()
.