Function docstrings::parse_md_docblock_events [−] [src]

pub fn parse_md_docblock_events<'a, I>(
    events: &mut Peekable<I>
) -> Result<DocBlock, ParseError> where
    I: Iterator<Item = Event<'a>>, 

Parse documentation and extract data

Parameters

  • md: Markdown

Returns

A Result, which is either

  • Ok(DocBlock): A type that contains all extracted information (including all unknown sections as Custom sections).
  • Err(ParseError): The first encountered error while parsing the documentation string.