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

Per-parameter signature help documentation #2501

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

datho7561
Copy link
Contributor

See #1291

Signed-off-by: David Thompson [email protected]

Use per-parameter documentation in signature help
instead of giving the entire method documentation.

Closes eclipse-jdtls#1291

Signed-off-by: David Thompson <[email protected]>
@datho7561
Copy link
Contributor Author

datho7561 commented Mar 6, 2023

I still need to support Markdown vs plaintext properly in this PR, and using regex to split up the parameter documentation isn't the most efficient solution, but other than that, I think this could work.

edit: I think I'm missing something, but I don't think that I can detect if the client supports markdown from the method where I'm generating the signature help parameter documentation.

@datho7561 datho7561 changed the title [WIP] per-parameter documentation Per-parameter signature help documentation Mar 6, 2023
@datho7561 datho7561 marked this pull request as ready for review March 6, 2023 19:07
@rgrunber
Copy link
Contributor

rgrunber commented Mar 7, 2023

According to the spec, https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#signatureHelpClientCapabilities , documentationFormat, is an array of MarkupKind that represents the preferred order of the format.

@datho7561
Copy link
Contributor Author

Yes, unfortunately I don't think I get that information in the function where I implement the per-param documentation. This means I will probably have to do a refactoring, so it might be a while longer for this PR. Also, while I'm at it, I should also refactor parts of JavadocContentAccess2 so that I can collect the parameter documentation without the general method documentation.

@datho7561 datho7561 marked this pull request as draft March 7, 2023 16:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants