Skip to main content

summary_for

Function summary_for 

fn summary_for(
    entry: &Export,
    declarations: &BTreeMap<String, Vec<Declaration>>,
) -> Result<String, Error>
Expand description

The rustdoc summary of one entry, resolved against the module it comes from.

§Errors

Error::Unclassifiable when the entry’s type cannot be found or has no doc comment. Both are fail-closed on purpose: an entry with an empty description is a page that lies by omission, and missing_docs means the doc comment is already mandatory.