eclipse-jdt / eclipse-jdt/eclipse.jdt.core
Javadoc hover should generate links to jls / jvms
- Dominant language
- Java
- Stars
- 237
- Forks
- 195
- Avg merge
- 1d 10h
- Merged PRs (30d)
- 49
Description
Inspired by reading https://www.javaspecialists.eu/archive/Issue308-Formatting-Inlined-value-in-Javadocs.html
I've opened [Class.isSynthetic() javadoc at Oracle ](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html#isSynthetic())

and compared the rendering with Javadoc view / hover at Eclipse:

I see that besides the rendering bug https://github.com/eclipse-jdt/eclipse.jdt.core/issues/1026 we also don't interpret `@jls` / `@jvms` tags and do not link to latest documents, which is not nice but would be useful.
So would be great if we could also support these extra `@jls` / `@jvms` tags.
Contributor guide
Research direction
Start in the Javadoc view and hover rendering, comparing the Oracle Javadoc example with Eclipse's output. Trace how the @jls and @jvms tags are handled and how links to the latest JLS and JVMS documents should be formed; done means both tags render as useful links alongside the existing Javadoc content.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100