Skip to main content

Crate rustdoc

Crate rustdoc 

Source

Re-exportsΒ§

pub(crate) use crate::clean::utils::DOC_RUST_LANG_ORG_VERSION; πŸ”’
pub(crate) use crate::config::EmitType; πŸ”’
pub(crate) use crate::error::Error; πŸ”’
pub(crate) use crate::formats::cache::Cache; πŸ”’
pub(crate) use env; πŸ”’
pub(crate) use VarError; πŸ”’
pub(crate) use io; πŸ”’
pub(crate) use IsTerminal; πŸ”’
pub(crate) use std::path::Path; πŸ”’
pub(crate) use std::process::ExitCode; πŸ”’
pub(crate) use rustc_ast::ast; πŸ”’
pub(crate) use rustc_errors::DiagCtxtHandle; πŸ”’
pub(crate) use rustc_hir::def_id::LOCAL_CRATE; πŸ”’
pub(crate) use rustc_interface::interface; πŸ”’
pub(crate) use rustc_middle::ty::TyCtxt; πŸ”’
pub(crate) use ErrorOutputType; πŸ”’
pub(crate) use Input; πŸ”’
pub(crate) use RustcOptGroup; πŸ”’
pub(crate) use make_crate_type_option; πŸ”’
pub(crate) use EarlyDiagCtxt; πŸ”’
pub(crate) use getopts; πŸ”’
pub(crate) use BytePos; πŸ”’
pub(crate) use Span; πŸ”’
pub(crate) use SyntaxContext; πŸ”’
pub(crate) use tracing::info; πŸ”’

ModulesΒ§

calculate_doc_coverage πŸ”’
Calculates information used for the --show-coverage flag.
clean πŸ”’
This module defines the primary IR used in rustdoc together with the procedures that transform rustc data types into it.
config πŸ”’
core πŸ”’
display πŸ”’
Various utilities for working with fmt::Display implementations.
docfs πŸ”’
Rustdoc’s FileSystem abstraction module.
doctest πŸ”’
error πŸ”’
externalfiles πŸ”’
fold πŸ”’
formats πŸ”’
html
json πŸ”’
Rustdoc’s JSON backend
lint πŸ”’
markdown πŸ”’
Standalone markdown rendering.
passes πŸ”’
The definitions of passes which transform crate information.
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Β§

dump_feature_usage_metrics πŸ”’
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 --read-doc-meta-dir are combined and written to the doc root.
run_renderer πŸ”’
usage πŸ”’
wrap_return πŸ”’