Skip to content

Extract documentation from comments #325

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

Closed
b-studios opened this issue Dec 1, 2023 · 1 comment · Fixed by #930
Closed

Extract documentation from comments #325

b-studios opened this issue Dec 1, 2023 · 1 comment · Fixed by #930
Assignees
Labels
feature New feature or request good first issue Good for newcomers

Comments

@b-studios
Copy link
Collaborator

Right now hovering over a reference shows the signature, which is helpful.
image

However, it would be great if it also could read out the comment and show it (maybe render it as markdown?).

One needs to look into https://github.com/effekt-lang/effekt/blob/master/effekt/shared/src/main/scala/effekt/Intelligence.scala (getInfoOf), but also at how comments are parsed, and potentially attached to source nodes.

This is related to (but not necessarily dependent on) implementing a documentation generator.

@b-studios b-studios added feature New feature or request good first issue Good for newcomers labels Dec 1, 2023
@jiribenes
Copy link
Contributor

As a start,

  1. lex /// single-line comments as a DocComment token,
  2. then parse it in the correct places in declarations/definitions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature New feature or request good first issue Good for newcomers
Projects
Development

Successfully merging a pull request may close this issue.

3 participants