Metadata-Version: 2.4
Name: tree-sitter-javadoc
Version: 0.0.3
Summary: Parser for Javadoc documentation comments
Author-email: Robert Muir <rmuir@apache.org>
License: MIT
Project-URL: Homepage, https://github.com/rmuir/tree-sitter-javadoc
Keywords: incremental,parsing,tree-sitter,javadoc
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Compilers
Classifier: Topic :: Text Processing :: Linguistic
Classifier: Typing :: Typed
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Provides-Extra: core
Requires-Dist: tree-sitter~=0.24; extra == "core"
Dynamic: license-file

# tree-sitter-javadoc

Javadoc grammar for [tree-sitter](https://github.com/tree-sitter/tree-sitter)

## About

Features:
* Complete old-school HTML (`/**`)
* Basic new-school Markdown (`///`) support
* Highlight queries, especially for those important/pesky `@see` and `@link` references
* `@nospell` set for javadocs syntax regions, so you don't have to turn spellcheck off anymore
* Injection queries for `@snippet`, `@value`
* Tested on heaps of java code, popular open source codebases
* Not perfect, but javadocs parsing is a dirty business

Screenshot of highlighting:
![Syntax highlighting screenshot](https://github.com/user-attachments/assets/0c08c36b-6bd3-4ef8-8ab7-ea434b2c5342)
