Enum solang_parser::doccomment::DocComment

pub enum DocComment {
    Line {
        comment: DocCommentTag,
    },
    Block {
        comments: Vec<DocCommentTag>,
    },
}

A Solidity parsed doc comment.

Variants

Line

Fields

comment: DocCommentTag

The single comment tag of the line.

A line doc comment.

/// doc comment

Block

Fields

comments: Vec<DocCommentTag>

The list of doc comment tags of the block.

A block doc comment.

/**
 * block doc comment
 */

Implementations

impl DocComment

pub fn comments(&self) -> Vec<&DocCommentTag>

Returns the inner comments.

pub fn into_comments(self) -> Vec<DocCommentTag>

Consumes self to return the inner comments.

Trait Implementations

impl Clone for DocComment

fn clone(&self) -> DocComment

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DocComment

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

Formats the value using the given formatter.

impl PartialEq for DocComment

fn eq(&self, other: &DocComment) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for DocComment

impl StructuralEq for DocComment

impl StructuralPartialEq for DocComment