RFR: 8338014: Improve usage of @jvms tags in class file API

[Joe Darcy]

On Mon, 12 Aug 2024 18:42:25 GMT, Joe Darcy <darcy at openjdk.org> wrote:

>> Hi all, 
>> 
>> This PR addresses [8338014](https://bugs.openjdk.org/browse/JDK-8338014) improving the use of `@jvms` tags by adding `JVMS` prior to the tag. 
>> 
>> Thanks, 
>> Sonia
>
> Looks fine; increasing review count to also include someone who more directly maintains this API.
> 
> If you haven't done so already, I recommend also doing a quick check for an analagous issue with `@jls` tags in this API.

> @jddarcy Perhaps we should revisit the inline forms of `@jls` and `@jvms` tags to come up with similar and more consistent usage.

Certainly a variant do generate the most common usage pattern would be helpful -- brainstorming --

`{@jvms cite 1.2.3}`

to generate

(JVMVS 1.2.3)

where "1.2.3" was the expected link.

-------------

PR Comment: https://git.openjdk.org/jdk/pull/20513#issuecomment-2284704350