rustdoc::html::render

Function document_short

Source
fn document_short<'a, 'cx: 'a>(
    item: &'a Item,
    cx: &'a Context<'cx>,
    link: AssocItemLink<'a>,
    parent: &'a Item,
    show_def_docs: bool,
) -> impl Display + 'a + Captures<'cx>
Expand description

Writes a documentation block containing only the first paragraph of the documentation. If the docs are longer, a “Read more” link is appended to the end.