https://github.com/the-mikedavis/tree-sitter-edoc

A tree-sitter grammar for the Erlang documentation generator (Edoc) syntax
https://github.com/the-mikedavis/tree-sitter-edoc

edoc erlang lexer parser tree-sitter

Last synced: about 2 months ago
JSON representation

A tree-sitter grammar for the Erlang documentation generator (Edoc) syntax

• Host: GitHub
• URL: https://github.com/the-mikedavis/tree-sitter-edoc
• Owner: the-mikedavis
• License: mit
• Created: 2022-05-27T19:03:18.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2022-11-23T03:03:29.000Z (over 3 years ago)
• Last Synced: 2025-04-05T02:41:53.441Z (about 1 year ago)
• Topics: edoc, erlang, lexer, parser, tree-sitter
• Language: JavaScript
• Homepage: https://the-mikedavis.github.io/tree-sitter-edoc/
• Size: 489 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# tree-sitter-edoc

_A tree-sitter grammar for the Erlang documentation generator (edoc) syntax_

### Status

`tree-sitter-edoc` is somewhat complete - it's usable but not very good yet.

Some improvements to do:

* Tags may only start on line beginnings

* Doc tags could parse the subject-line (everything before first `.`)

* Inject Erlang into `@type` and `@spec`? I lean towards no, those should be migrated into `-type` and `-spec` attributes and might be tricky to parse

* Find bugs! :bug: