https://github.com/killercup/rust-docstrings
https://github.com/killercup/rust-docstrings
rust
Last synced: 8 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/killercup/rust-docstrings
- Owner: killercup
- License: apache-2.0
- Created: 2016-09-03T12:41:43.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-06-17T21:04:01.000Z (almost 9 years ago)
- Last Synced: 2024-10-12T03:25:01.081Z (over 1 year ago)
- Topics: rust
- Language: Rust
- Homepage: https://deterministic.space/machine-readable-inline-markdown-code-cocumentation.html
- Size: 768 KB
- Stars: 11
- Watchers: 4
- Forks: 4
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
# 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](https://scribbles.pascalhertleif.de/machine-readable-inline-markdown-code-cocumentation.html).
[](https://travis-ci.org/killercup/rust-docstrings)
[](https://coveralls.io/github/killercup/rust-docstrings?branch=master)
[Rendered **Documentation** of master branch.](https://killercup.github.io/rust-docstrings/)
## What it does
For example, given a string like this one:
```markdown
Lorem ipsum
A longer description lorem ipsum dolor sit amet.
# Parameters
- `param1`: Foo
- `param2`: Bar
```
it will return structure like this:
```rust
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
- Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or )
- MIT license ([LICENSE-MIT](LICENSE-MIT) or )
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.