Render Groovydoc in hover for classes, methods and fields. about groovy-language-server

[joshtynjala]

I wonder if Groovy 3 exposes the doc comments or not? I'm waiting on them to release a particular bug fix before I upgrade to Groovy 3. I know some of the APIs have improved, but I haven't had much chance to dive in very deeply. I only learned enough of the new API to get the current features of the language server working (minus one or two that need that bug fix).

[shadycuz]

@joshtynjala coolio, I will focus on a Groovy 3 implementation. Let me do some research in the day or two and get back to you.

[shadycuz]

@joshtynjala So the first sentence of the Groovy3 release notes talks about switching to parrot.

Parrot for sure offers javadoc comments when it creates the AST. Does that mean when we switch to groovy 3 we will have access to parrot? If so then implementing this will be a lot easier.

[joshtynjala]

Yeah, with that in mind, it sounds like implementing this will be much easier with Groovy 3.

[shadycuz]

This was further down the page "runtime groovydoc, i.e. groovydoc with @Groovydoc; groovydoc attached to AST node as metadata"

@joshtynjala So it seems like annotated groovy doc will be there, I'm not sure about normal groovydoc? I should be able to create a feature branch off of the groovy3 branch and see if normal comments work correctly right?

[shadycuz]

From the parrot docs

groovy.attach.runtime.groovydoc: whether to attach @Groovydoc annotation to all members which have groovydoc(i.e. /**@ ... */)

So it seems like a way exists to force parrot to treat all groovy-doc like its runtime.

[joshtynjala]

Yeah, feel free create a branch off the groovy3 branch and see what you can find.