Crate rustdoc[][src]

Re-exports

extern crate std;
extern crate arena;
extern crate getopts;
extern crate env_logger;
extern crate rustc;
extern crate rustc_data_structures;
extern crate rustc_codegen_utils;
extern crate rustc_driver;
extern crate rustc_resolve;
extern crate rustc_lint;
extern crate rustc_metadata;
extern crate rustc_target;
extern crate rustc_typeck;
extern crate serialize;
extern crate syntax;
extern crate syntax_pos;
extern crate test as testing;
extern crate log;
extern crate rustc_errors as errors;
extern crate pulldown_cmark;
extern crate tempdir;
extern crate minifier;
extern crate serialize as rustc_serialize;
use std::prelude::v1::*;
use errors::ColorConfig;
use std::collections::BTreeMap;
use std::collections::BTreeSet;
use std::default::Default;
use std::env;
use std::path::Path;
use std::path::PathBuf;
use std::process;
use std::sync::mpsc::channel;
use syntax::edition::Edition;
use externalfiles::ExternalHtml;
use rustc::session::early_warn;
use rustc::session::early_error;
use rustc::session::search_paths::SearchPaths;
use rustc::session::config::ErrorOutputType;
use rustc::session::config::RustcOptGroup;
use rustc::session::config::Externs;
use rustc::session::config::CodegenOptions;
use rustc::session::config::nightly_options;
use rustc::session::config::build_codegen_options;
use rustc_target::spec::TargetTriple;
use clean::AttributesExt;

Modules

clean

This module contains the "cleaned" pieces of the AST, and the functions that clean them.

core
doctree

This module is used to store stuff from Rust's AST in a more convenient manner (and with prettier names) before cleaning.

externalfiles
fold
html
markdown
passes
plugins
test
theme
visit_ast

Rust AST Visitor. Extracts useful information and massages it into a form usable for clean

visit_lib

Structs

Output

Functions

acquire_input

Looks inside the command line arguments to extract the relevant input format and files and then generates the necessary rustdoc output for formatting.

check_deprecated_options

Prints deprecation warnings for deprecated options

get_args
main
main_args
opts
parse_externs

Extracts --extern CRATE=PATH arguments from matches and returns a map mapping crate names to their paths or else an error message.

rust_input

Interprets the input file as a rust source file, passing it through the compiler all the way through the analysis passes. The rustdoc output is then generated from the cleaned AST of the crate.

stable
unstable
usage