eclipse-jdt / eclipse-jdt/eclipse.jdt.core

Javadoc hover should generate links to jls / jvms

Open
#1,027 0 comments 0 reactions 0 assignees View on GitHub
bug javadoc
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())

![image](https://user-images.githubusercontent.com/964108/235682303-20fda5e6-c183-4073-95a4-a7747e9ec39a.png)

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

![image](https://user-images.githubusercontent.com/964108/235682749-060c7c75-384b-4662-b7cf-9033e7af2844.png)

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

Open the contributing 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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.