Struct Doc 

pub struct Doc<'a> {
    pub summary: Option<&'a str>,
    pub description: Description<'a>,
}

Documentation associated with an element.

Fields

summary: Option<&'a str>

Documentation summary.

description: Description<'a>

Description.

Implementations

impl<'a> Doc<'a>

pub fn lines(&self) -> impl Iterator<Item = &'a str>

Iterate over the lines of documentation, if there are any.

Leading and trailing whitespace is trimmed from each line, since documentation in an interface file is indented to match the surrounding XML rather than the text.

pub fn is_empty(&self) -> bool

Test if there is no documentation at all.

Trait Implementations

impl<'a> Clone for Doc<'a>

fn clone(&self) -> Doc<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Doc<'a>

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

Formats the value using the given formatter.

impl<'a> Default for Doc<'a>

fn default() -> Doc<'a>

Returns the “default value” for a type.