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

Javadoc in hover messages (first revision) #66

Merged
merged 8 commits into from
Nov 21, 2019
Merged

Conversation

Strum355
Copy link
Contributor

Works for on call and declaration sites

@Strum355
Copy link
Contributor Author

I believe this crashes and/or doesnt work with classes/objects yet

@Strum355
Copy link
Contributor Author

Strum355 commented Oct 25, 2018

Hovering over class constructor calls eg val input = ExitOnClose(System.in), there is no problem and it shows the javadoc
Hovering over a class name at its declaration site, it throws the below exception. It only throws the exception if the previous hover (aka over constructor call site) hasnt been performed. Once you hover at call site, hovering over declaration site just returns nothing

https://hastebin.com/ayohoquxox.cs

@fwcd
Copy link
Owner

fwcd commented Oct 28, 2018

@Strum355 Thanks for your contribution, I won't merge the PR as long as it has a WIP tag though.

@Strum355
Copy link
Contributor Author

https://github.com/eclipse/eclipse.jdt.ls/blob/master/org.eclipse.jdt.ls.core/src/org/eclipse/jdt/ls/core/internal/javadoc/JavaDocLocations.java this link would probably be useful, the vscode java extension seems to have issues with this repo so im having issues following it without having errors yelled at my face, but itd be a good start

@fwcd fwcd added the enhancement New feature or request label Aug 1, 2019
@Strum355
Copy link
Contributor Author

Strum355 commented Aug 7, 2019

@fwcd has this functionality been added to master since this PR has been created or is this PR still good to have more work done to it?

@fwcd
Copy link
Owner

fwcd commented Aug 7, 2019

@Strum355 There is no equivalent functionality yet, so reviving this PR would be great. 👍

@LifeIsStrange
Copy link

@fwcd we need this!

@Strum355 Strum355 force-pushed the javadoc-hover branch 2 times, most recently from 0e7df8c to 926144b Compare November 21, 2019 16:41
@Strum355
Copy link
Contributor Author

Brought this PR up to speed, it doesnt work for some situations but we can remedy that in later cases. as far as im aware, this currently only works for call expressions and function declarations, but not for class signatures from what ive seen. Class signature hover in general doesnt work in all cases eg hovering KotlinTextDocumentService gives nothing while for other class definitions it does.

This PR can be merged to give users at least something to begin with :)

@Strum355 Strum355 changed the title [WIP] Javadoc in hover messages Javadoc in hover messages (first revision) Nov 21, 2019
@fwcd fwcd merged commit 266d1dd into fwcd:master Nov 21, 2019
@Strum355 Strum355 deleted the javadoc-hover branch January 7, 2020 14:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants