Enum docstrings::DocSection

pub enum DocSection {
    Parameters(Vec<(Identifier, Documentation)>),
    TypeParameters(Vec<(Identifier, Documentation)>),
    LifetimeParameters(Vec<(Identifier, Documentation)>),
    Returns(Documentation, Vec<(Pattern, Documentation)>),
    Custom(SectionHeadline, Documentation),
}

Documentation sections

Variants

Parameters(Vec<(Identifier, Documentation)>)

Function parameters, mapping param name to docs

TypeParameters(Vec<(Identifier, Documentation)>)

Type parameters (generics), mapping ident of generic to docs

LifetimeParameters(Vec<(Identifier, Documentation)>)

Lifetime parameters, documenting the life and death of your times

Returns(Documentation, Vec<(Pattern, Documentation)>)

Return value documentation with optional list of enum variants.

Custom(SectionHeadline, Documentation)

Custom/unknown sections, mapping headlines to docs

In the future, some of the sections currently treated as 'custom' may be added as new variants, e.g. 'Examples', or 'Panics'.

Trait Implementations

impl Debug for DocSection

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

Formats the value using the given formatter.

impl PartialEq for DocSection

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

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

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

This method tests for !=.

impl Eq for DocSection

impl Clone for DocSection

fn clone(&self) -> DocSection

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Hash for DocSection

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].