Crate docstrings [] [src]

Extract data from documentation strings.

The expected format is described here.

Structs

DocBlock

Information extracted from a doc comment

Enums

DocSection

Documentation sections

ParseError

Errors while parsing documention

Functions

parse_md_docblock

Parse documentation and extract data

parse_md_docblock_events

Parse documentation and extract data

Type Definitions

Documentation

Documentation, a Markdown String

Identifier

A Rust identifier

Pattern

A Rust pattern, as used in pattern matching.

SectionHeadline

The headline of a section