Struct DocBlock 

pub struct DocBlock {
    pub summary: String,
    pub details: Option<String>,
    pub src_ref: SrcRef,
}

Block of documentation comments, starting with /// .

Fields

summary: String

Doc summary.

details: Option<String>

Doc details.

src_ref: SrcRef

Source reference.

Implementations

impl DocBlock

pub fn new_builtin(comment: &str) -> Self

Create new doc block for builtin.

Trait Implementations

impl Clone for DocBlock

fn clone(&self) -> DocBlock

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for DocBlock

fn default() -> DocBlock

Returns the “default value” for a type.

impl Display for DocBlock

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

Formats the value using the given formatter.

impl Parse for DocBlock

fn parse(pair: Pair<'_>) -> ParseResult<Self>

impl SrcReferrer for DocBlock

fn src_ref(&self) -> SrcRef

Return source code reference.

fn source_hash(&self) -> u64

Return source code hash.

impl TreeDisplay for DocBlock

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

Write item into f and use {:depth$} syntax in front of your single line output to get proper indention.

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

Display as tree starting at depth 0.

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

Display as tree starting at given depth in debug mode

fn write_tree(&self, f: &mut impl Write) -> Result<()>

Display as tree starting at depth 0 into a file