Crate rustdoc

Source

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 for clean.
  • visit_lib πŸ”’

Macros§

Functions§

  • init_logging πŸ”’
  • main_args πŸ”’
  • opts πŸ”’
  • 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().