Struct DocComment 

pub struct DocComment {
    pub text: String,
    pub kind: DocKind,
    pub span: Span,
}

A Haddock-style documentation comment.

Fields

text: String

The raw text content of the documentation.

kind: DocKind

The kind of documentation (preceding or trailing).

span: Span

The span of the comment in source.

Implementations

impl DocComment

pub fn preceding(text: String, span: Span) -> Self

Create a new preceding documentation comment.

pub fn trailing(text: String, span: Span) -> Self

Create a new trailing documentation comment.

Trait Implementations

impl Clone for DocComment

fn clone(&self) -> DocComment

Returns a duplicate 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.