javavscode icon indicating copy to clipboard operation
javavscode copied to clipboard

Document `jdk.hints.preferences` file format

Open kalaracey opened this issue 1 year ago • 2 comments

The extension description includes the following section:

Hints Preferences

Easily update default hint preferences by adjusting a simple configuration option to tailor hint preferences to specific needs.

Go to VSCode View | Command Palette | Preferences:Open User Settings | Extensions | Java and set Jdk › Hints: Preferences: option to the xml hint preferences file.

Note that there is no documentation of what this file or its format is. I think what is missing is a link to a Wiki page similar to the link in the Formatting Preferences section to the Java Formatting Preferences Wiki page.

See also: https://github.com/oracle/javavscode/issues/239

kalaracey avatar Nov 11 '24 21:11 kalaracey

I think this is the right place:

Screenshot 2024-11-11 at 4 02 30 PM

And then export.

kalaracey avatar Nov 11 '24 21:11 kalaracey

Hey @kalaracey, thanks for pointing this out. We would add a wiki for hints preferences setting as well.

Achal1607 avatar Nov 12 '24 06:11 Achal1607

Wiki added Java hint prefs. Thanks.

Achal1607 avatar May 27 '25 05:05 Achal1607

For me the hints does not work as expected / as configured in Netbeans, e.g., wrong JavaDoc entries are not highlighted. The formatting works as expected. When clicking the "Export..." button, the same export screen as described in Java formatting preferences shows up. Which settings needs to be selected to get it working?

Britz avatar Jun 13 '25 13:06 Britz

For me the hints does not work as expected / as configured in Netbeans, e.g., wrong JavaDoc entries are not highlighted. The formatting works as expected. When clicking the "Export..." button, the same export screen as described in Java formatting preferences shows up. Which settings needs to be selected to get it working?

Yes, I also need further configuration instructions to make it work as expected. Clicking export in NetBeans always exports to zip instead of xml. Trying to use a project-level nb-configuration.xml file also didn't work. @Achal1607

nikbobo avatar Aug 03 '25 19:08 nikbobo