Skip to main content

Module docs

Module docs 

Source
Expand description

Documentation extraction and source mapping.

This module handles the extraction and processing of doc comments and #[doc = "..."] attributes, including macro expansion for #[doc = macro!()] patterns. It builds a concatenated string of the full docs as well as a source map to map it back to AST (which is needed for things like resolving links in doc comments and highlight injection).

StructsΒ§

DocMacroExpander πŸ”’
Docs
DocsSourceMapLine πŸ”’
Indent πŸ”’

EnumsΒ§

DocCommentKind πŸ”’
IsInnerDoc

FunctionsΒ§

expand_doc_expr_via_macro_pipeline πŸ”’
expand_doc_macro_call πŸ”’
extend_with_attrs πŸ”’
extract_docs πŸ”’
get_horizontal_trim πŸ”’
Copied verbatim from rustc’s beautify_doc_string, modulo CommentKind/CommentShape renaming and returning String rather than interning to Symbol.
get_vertical_trim πŸ”’
Copied verbatim from rustc’s beautify_doc_string, modulo CommentKind/CommentShape renaming.