2 releases

Uses old Rust 2015

0.1.1 Jun 17, 2017
0.1.0 May 30, 2017

#52 in #documentation

MIT/Apache

15KB
235 lines

Markdown doc string parser

This is a proof of concept.

This Rust library can be used to extract some data from documentation formatted as described here.

Build Status Coverage Status

Rendered Documentation of master branch.

What it does

For example, given a string like this one:

Lorem ipsum

A longer description lorem ipsum dolor sit amet.

# Parameters

- `param1`: Foo
- `param2`: Bar

it will return structure like this:

DocBlock {
    teaser: "Lorem ipsum",
    description: Some("A longer description lorem ipsum dolor sit amet."),
    sections: [
        Parameters([
            ("param1", "Foo"),
            ("param2", "Bar")
        ])
    ]
}

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Dependencies

~550KB
~13K SLoC