Trait ink_ir::IsDocAttribute

pub trait IsDocAttribute {
    fn is_doc_attribute(&self) -> bool;
    fn extract_docs(&self) -> Option<String>;
}

An extension trait for syn::Attribute in order to query for documentation.

Required Methods

fn is_doc_attribute(&self) -> bool

Returns true if the attribute is a Rust documentation attribute.

fn extract_docs(&self) -> Option<String>

Returns the contents of the Rust documentation attribute or None.

Implementations on Foreign Types

impl IsDocAttribute for Attribute

fn is_doc_attribute(&self) -> bool

fn extract_docs(&self) -> Option<String>

Implementors