Struct DocComment 

pub struct DocComment<'ast> {
    pub kind: CommentKind,
    pub span: Span,
    pub symbol: Symbol,
    pub natspec: &'ast mut RawThinSlice<(), NatSpecItem>,
}

A single doc-comment: /// foo, /** bar */.

Fields

kind: CommentKind

The comment kind.

span: Span

The comment’s span including its “quotes” (//, /**).

symbol: Symbol

The comment’s contents excluding its “quotes” (//, /**) similarly to symbols in string literal tokens.

natspec: &'ast mut RawThinSlice<(), NatSpecItem>

The comment’s natspec items

Implementations

impl<'ast> DocComment<'ast>

pub fn natspec_content<'a>(&self, item: &'a NatSpecItem) -> &'a str

Returns the content of a natspec excluding its tag.

Trait Implementations

impl<'ast> Debug for DocComment<'ast>

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.