JDK-8338014 : Improve usage of @jvms tags in class file API
  • Type: Bug
  • Component: core-libs
  • Sub-Component: java.lang.classfile
  • Affected Version: 24
  • Priority: P4
  • Status: Resolved
  • Resolution: Fixed
  • Submitted: 2024-08-08
  • Updated: 2024-08-26
  • Resolved: 2024-08-15
The Version table provides details related to the release that this issue/RFE will be addressed.

Unresolved : Release in which this issue/RFE will be addressed.
Resolved: Release in which this issue/RFE has been resolved.
Fixed : Release in which this issue/RFE has been fixed. The release containing this fix may be available for download as an Early Access Release or a General Availability Release.

To download the current JDK release, click here.
JDK 24
24 b12Fixed
Related Reports
Relates :  
Description
In various parts of the class file api where the `@jvms` tag is used as an inline tag, it is used in an idiom like:

"... as defined in {@jvms 4.7.20.2}"

This renders as

"... as defined in 4.7.20.2."

where "4.7.20.2" is a link to a the corresponding section. Elsewhere in core libs, the pattern used is 

"... as defined in JVMS {@jvms 4.7.20.2}"

which renders as

"... as defined in JVMS 4.7.20.2."

which IMO is much clearer to reader.
Comments
Changeset: 56dec215 Branch: master Author: Sonia Zaldana Calles <szaldana@openjdk.org> Date: 2024-08-15 13:28:25 +0000 URL: https://git.openjdk.org/jdk/commit/56dec215b0d056fc23137372ecb3376af2a7b891
15-08-2024

A pull request was submitted for review. Branch: master URL: https://git.openjdk.org/jdk/pull/20513 Date: 2024-08-08 18:15:29 +0000
12-08-2024