Feat: Hover in language server display documentation #2364
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# Conflicts: # Source/Dafny.sln # Source/Dafny/AST/DafnyAst.cs # Source/Dafny/Resolver.cs # Source/Directory.Build.props # Test/libraries
…into feat-add-trivia
# Conflicts: # Source/Dafny/Verifier/Translator.ClassMembers.cs # Source/Dafny/Verifier/Translator.cs
…into feat-add-trivia
# Conflicts: # RELEASE_NOTES.md # Source/DafnyLanguageServer.Test/Lookup/HoverTest.cs
This reverts commit 45e661a.
|
Closed in favor of #3756 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR makes it possible to hover over a symbol and not only see the signature of the declaration, but also the comment that precedes it.
Any comment in
/** */or///will be visualized as plain markdown.If this comment is detected to have a subset of the JavaDoc format, it is formatted as such.
No change to the IDE extension is required.
Screenshots
On functions
On fields
Unformatted comments:
The most relevant test is here and test comments on constants, fields, methods, functions, lemmas, predicates, least predicates, twostate lemmas...
https://github.com/dafny-lang/dafny/pull/1801/files#diff-1edc7ab0bf5b3c02cf78f59e65636710aeaf47a0a5e37f889a3c364a5cf207b5R432
Implementation details
To review:
By submitting this pull request, I confirm that my contribution is made under the terms of the MIT license.