Struct DocComment 

pub struct DocComment {
    pub text: String,
    pub is_module_doc: bool,
    pub span: ByteRange,
}

A documentation comment attached to a declaration.

Fields

text: String

The raw comment text (without the /-- delimiters).

is_module_doc: bool

Whether this is a module-level doc comment.

span: ByteRange

Byte range of the comment in the source.

Implementations

impl DocComment

pub fn new(text: &str, span: ByteRange) -> Self

Create a doc comment.

pub fn module_doc(text: &str) -> Self

Create a module-level doc comment.

pub fn first_line(&self) -> &str

The first line of the doc comment (for summaries).

pub fn is_empty(&self) -> bool

Whether the doc comment is empty.

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.

impl Display 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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for DocComment

impl StructuralPartialEq for DocComment