Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Save doc comments in the token table. #240

Open
typeswitch-dev opened this issue Apr 13, 2024 · 0 comments
Open

Save doc comments in the token table. #240

typeswitch-dev opened this issue Apr 13, 2024 · 0 comments
Labels
compiler Compiler internals.

Comments

@typeswitch-dev
Copy link
Contributor

Doc comments annotate the following atom, usually some kind of a definition:

||| This is a doc comment.
def(bar, ..., ...)

Right now these are discarded in the lexer. Instead they should either be saved as a token, or stored as part of the following token. Importantly, multiple doc comment lines ought to be combined (while preserving the lines), e.g.

||| Line 1 of doc comment
||| Line 2 of doc comment
def(my-word, ..., ...)
@typeswitch-dev typeswitch-dev added feature New feature or request compiler Compiler internals. and removed feature New feature or request labels Apr 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
compiler Compiler internals.
Projects
None yet
Development

No branches or pull requests

1 participant