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.

Sign up for GitHub

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

Jump to bottom

Implement Hover Request #5

Open
3 tasks
AnHeuermann opened this issue Feb 8, 2024 · 1 comment · May be fixed by #20
Open
3 tasks

Implement Hover Request #5

AnHeuermann opened this issue Feb 8, 2024 · 1 comment · May be fixed by #20
Assignees
@AnHeuermann
Labels
LS - Client Language Server - Client capability LS - Server Language Server - Server capability

Comments

@AnHeuermann
Copy link
Member

AnHeuermann commented Feb 8, 2024 •
edited
Loading

Description

Implement server capability Hover Request.

The hover request is sent from the client to the server to request hover information at a given text document position.

Desired features

  • Documentation on hover
    • Display doc-strings of classes (so every model, block, type and so on / everything's a class in Modelica)
    • (Optional) Display documentation annotation of classes (basically HTML)
    • Input and output types and doc-strings
  • Server test
  • Client end to end test

Example

In TypeScript this looks something like

grafik

OMEdit displays the doc-string of the class when writing, but not the documentation annotation.

grafik
@AnHeuermann AnHeuermann added LS - Server Language Server - Server capability LS - Client Language Server - Client capability labels Feb 8, 2024
@AnHeuermann AnHeuermann changed the title Implement Hover Provider Implement Hover Request Feb 8, 2024
@AnHeuermann AnHeuermann moved this to In progress in Modelica Language Server Feb 8, 2024
@osman362
Copy link
Contributor

I am currently working on it.
Right now the server only recognizes line comments above a class.

@AnHeuermann AnHeuermann linked a pull request May 23, 2024 that will close this issue
Implementation of the Hover feature #20
Draft
@AnHeuermann AnHeuermann assigned AnHeuermann and unassigned osman362 May 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@AnHeuermann AnHeuermann

Labels
LS - Client Language Server - Client capability LS - Server Language Server - Server capability
Projects
Modelica Language Server
Status: In progress
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Implementation of the Hover feature AnHeuermann/modelica-language-server
2 participants
@AnHeuermann @osman362