Struct docstrings::DocBlock

pub struct DocBlock {
    pub teaser: String,
    pub description: Option<Documentation>,
    pub sections: Vec<DocSection>,
}

Information extracted from a doc comment

Fields

teaser: String

First line

description: Option<Documentation>

Paragraphs after first line

sections: Vec<DocSection>

Sections

Trait Implementations

impl Debug for DocBlock

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl PartialEq for DocBlock

fn eq(&self, __arg_0: &DocBlock) -> bool

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

fn ne(&self, __arg_0: &DocBlock) -> bool

This method tests for !=.

impl Eq for DocBlock

impl Clone for DocBlock

fn clone(&self) -> DocBlock

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Hash for DocBlock

fn hash<__H: Hasher>(&self, __arg_0: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].