Skip to main content

collect_comments

Function collect_comments 

Source
fn collect_comments(
    docs: &DocComments<'_>,
    name_to_page: &NameToPage,
    page_path: &Path,
    local: Option<&LocalMembers>,
) -> CommentData
Expand description

Collect natspec from doc comments, applying inline link replacement.

Solar emits each /// line as a separate DocComment. Lines without a @ tag become synthetic @notice items. We join adjacent synthetic items to the previous rendered section so multi-line natspec tags form a single coherent block in source order.