Crate rustdoc

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 🔒
• html
• json 🔒
  Rustdoc’s JSON backend
• lint 🔒
• markdown 🔒
• 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 for clean.
• visit_lib 🔒

Macros

• map 🔒
  A macro to create a FxHashMap.
• try_err
• try_none

Functions

• init_logging 🔒
• main
• 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

• MainResult 🔒
  A result type used by several functions under main().