doctor 0.3.0

About

This crate seeks to be a low-level parser for Javadoc-style doc comment formats, e.g. JavaDoc, JSDoc, TSDoc, etc.

Example

use doctor::parse;
use doctor::ast::{DocComment, Description, BodyItem, InlineTag};

assert_eq!(
    parse(r#"/**
        * This is a doc comment.
        * It contains an {@inlineTag with some body} in its description.
        */"#
    ),
    Ok(DocComment {
        description: Some(Description {
            body_items: vec![
                BodyItem::TextSegment("This is a doc comment.\n"),
                BodyItem::TextSegment("It contains an "),
                BodyItem::InlineTag(InlineTag {
                    name: "inlineTag",
                    body_lines: vec!["with some body"],
                }),
                BodyItem::TextSegment("in its description.\n")
            ]
        }),
        block_tags: vec![]
    }),
);

🔮 Design Goals

• The crate is agnostic from the concrete set of valid tags so that more high-level parsers (JSDoc, TSDoc, etc.) can be built on top of it.
• The parser tries to allocate as little memory as possible to ensure great performance, so the AST format is designed to use slices of the input data as much as possible.

👯‍ Contributing

Please check the contributing documentation