Module rustdoc::clean

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

Modules

auto_trait 🔒

blanket_impl 🔒

cfg 🔒

The representation of a #[doc(cfg(...))] attribute.

inline 🔒

Support for inlining external documentation into the current AST.

render_macro_matchers 🔒

simplify 🔒

Simplification of where-clauses and parameter bounds into a prettier and more canonical form.

types 🔒

utils 🔒

Traits

Clean 🔒

Functions

clean_args_from_types_and_body_id 🔒

clean_args_from_types_and_names 🔒

clean_extern_crate 🔒

clean_field 🔒

clean_fn_decl_from_did_and_sig 🔒

clean_fn_decl_legacy_const_generics 🔒

This is needed to make it more “readable” when documenting functions using rustc_legacy_const_generics. More information in https://github.com/rust-lang/rust/issues/83167.

clean_fn_decl_with_args 🔒

clean_fn_or_proc_macro 🔒

clean_function 🔒

clean_generic_param 🔒

clean_impl 🔒

clean_maybe_renamed_foreign_item 🔒

clean_maybe_renamed_item 🔒

clean_poly_trait_ref_with_bindings 🔒

clean_projection 🔒

clean_qpath 🔒

clean_trait_ref_with_bindings 🔒

clean_ty 🔒

clean_ty_generics 🔒

clean_use_statement 🔒

compute_should_show_cast 🔒

is_elided_lifetime 🔒

This can happen for async fn, e.g. async fn f<'_>(&'_ self).

is_field_vis_inherited 🔒

is_impl_trait 🔒

Synthetic type-parameters are inserted after normal ones. In order for normal parameters to be able to refer to synthetic ones, scans them first.

maybe_expand_private_type_alias 🔒

normalize 🔒

Returns None if the type could not be normalized

projection_to_path_segment 🔒