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

Javadoc @value doesnt work as expected (also @implSpec and @implNote) #3385

Closed
Nightenom opened this issue Nov 9, 2023 · 4 comments
Closed

Comments

@Nightenom
Copy link

Nightenom commented Nov 9, 2023

{@value target} is not displayed as expected.
Java spec describing the feature: https://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html#CHDDCDHH

Environment
  • Operating System: w11 pro 22H2
  • JDK version: adoptium openjdk 17.0.8.1 2023-08-24
  • Visual Studio Code version: 1.83.1
  • Java extension version: v1.25.2023110903
Steps To Reproduce
  1. Use supplied code below
  2. Hover over class to display its javadoc
  3. Suprisingly it works if you dont supply the class name, ie. just #CONSTANT_VALUE
Current Result

image

Expected Result

Actual value to be inserted, the value according to latest javadoc generator should(?) be with quotes included

Additional Informations
/**
 * {@link Test#CONSTANT_LINK}
 * <p>
 * {@value Test#CONSTANT_VALUE}
 */
public class Test
{
    public static final String CONSTANT_LINK = "hello link";
    public static final String CONSTANT_VALUE = "hello value";
}
@Nightenom Nightenom changed the title Javadoc @value doesnt work as expected Javadoc @value doesnt work as expected (also @implSpec and @implNote) Nov 9, 2023
@fbricon
Copy link
Collaborator

fbricon commented Nov 9, 2023

I confirm this is an issue in upstream Eclipse JDT (that vscode-java consumes). Could you please open this ticket in https://github.com/eclipse-jdt/eclipse.jdt.core/issues?

@Nightenom
Copy link
Author

@fbricon got rejected there, what now?

@fbricon
Copy link
Collaborator

fbricon commented Nov 20, 2023

I'm currently touching the javadoc rendering code in jdt.ls, so I'll see where the problem is then.

@Nightenom
Copy link
Author

This seems to be working in latest versions

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants