Function extract_docblock_description

src/hover/formatting.rs:513–517

Extract the human-readable description text from a raw docblock string. Parses the docblock with `mago-docblock` and returns the free-text content before the first `@tag`, with basic HTML converted to Markdown. Returns `None` if no description text is present.

(docblock: Option<&str>)

/// content before the first `@tag`, with basic HTML converted to Markdown.
/// Returns `None` if no description text is present.
pub(crate) fn extract_docblock_description(docblock: Option<&str>) -> Option<String> {
    let raw = docblock?;
    let info = parse_docblock_for_tags(raw)?;
    extract_description_from_info(&info)
}

/// Shorten all namespace-qualified class names in a type string to their
/// short (unqualified) form.