Hover documentation missing links to types in signature

[mickaelistria]

Coming from Eclipse JDT, I miss noticeably the links to the signature types in the hover documentation.

[rgrunber]

So hovers like :

where the type arguments/return for the method could definitely have links. I think it should be possible. In other instances, we embed links directly with markdown syntax.

[fbricon]

Javadoc returns links to binary types if the client supports classFileContentsSupport

[rgrunber]

Yup, that extended client capability among some others should probably be enabled. In Eclipse, clicking a link to a type just loads the Javadoc for that type in the hover. I'm not sure if we can do this, though we could definitely jump to the type declaration. Maybe @JessicaJHee could have a look when there's time.

[JessicaJHee]

I'm interested in working on this!

[JessicaJHee]

We currently display the hover result in markdown code with the language java so that it handles syntax coloration.

If we wanted to insert the links, we would have to change the hover result to markdown without marking it as code. Currently, I don't believe that there is a way to have both syntax coloration and ability to insert link. The result would look something like this:

We can discuss whether adding the links is worth losing the syntax coloration?

[rgrunber]

From playing around with it, seems like highlighted markdown code blocks don't support embedded links.

/**
 * [jdt-ls](https://github.com/eclipse/eclipse.jdt.ls)
**/
public class Foo {
}

Inline code blocks do (eg. jdt-ls but those have no way to specify the language highlighting preference (as above). I guess we need to decide if the links are worth losing proper fromat/highlighting.

[mickaelistria]

The links could be placed in the later parameter/return description, eg something like

---

Integer Car.testMethod(String test) throws NoSuchCarException

This is a test method

• Parameters
  • String test Javadoc parameter blurb, empty if none
• Return Integer javadoc return blurb, empty if none
• Excpetions
  • NoSuchCarException javadoc exception blurb

---

[rgrunber]

It could be done, but that first line is what is generated for all members (eg. method declarations). The part after, is generated by the user in the form of Javadoc. So either we detect the types in their Javadocs (hopefully they've written proper Javadocs.. heheh 😉 ) or if a method has no Javadoc, we generate it like above. I'm assuming that's what you're implying with the above sample ?