Function check_doc_attribute

src/utils.rs:151–165

Checks if an attribute's [`syn::Meta`] property is a name-value pair, like `doc = "Single line doc comments"`. if so, continues to check that the value (.e.g. "Single line doc comments") is a valid [`proc_macro2::TokenTree::Literal`], if so, add it to the collection of comment strings.

(attr: &syn::Attribute)

/// (.e.g. "Single line doc comments") is a valid [`proc_macro2::TokenTree::Literal`],
/// if so, add it to the collection of comment strings.
fn check_doc_attribute(attr: &syn::Attribute) -> Vec<String> {
    // Check if the attribute's meta is a NameValue, otherwise return
    // right away.
    let syn::Meta::NameValue(ref nv) = attr.meta else {
        return Default::default();
    };

    // Convert the value to a token stream, then iterate it, collecting
    // only valid comment string.
    nv.value
        .to_token_stream()
        .into_iter()
        .filter_map(check_doc_tokens)
        .collect::<Vec<String>>()
}

/// Get the doc string comments from the syn::attributes
/// note: the compiler transforms doc comments into attributes