RFR: 8342469: Improve API documentation for java.lang.classfile.instruction [v3]

[Adam Sotona]

On Mon, 18 Nov 2024 02:58:31 GMT, Chen Liang <liach at openjdk.org> wrote:

>> Improve the documentation for classfile instructions. Includes links to all opcodes, usage notes for instructions, and other various fixes.
>> 
>> API Diff: https://cr.openjdk.org/~liach/apidiff/cf-instr/java.base/module-summary.html
>> Javadoc: https://cr.openjdk.org/~liach/javadoc/cf-instr/java.base/java/lang/classfile/instruction/package-summary.html
>> 
>> Please review the associated CSR as well.
>
> Chen Liang has updated the pull request with a new target base due to a merge or a rebase. The pull request now contains six commits:
> 
>  - Further facelift
>  - Merge branch 'master' of https://github.com/openjdk/jdk into docs/cf-instruction
>  - Merge branch 'master' of https://github.com/openjdk/jdk into docs/cf-instruction
>  - Typos, long lines
>  - Labels
>  - Wip instr

src/java.base/share/classes/java/lang/classfile/instruction/ConstantInstruction.java line 58:

> 56:  * <p>
> 57:  * Physically, a constant-load instruction is polymorphic; nested interfaces in
> 58:  * this interface model different constant instructions as records.

I'm not sure what the sentence "nested interfaces in this interface model different constant instructions as records" gives to users and on the other side what obligation does it mean from the JCK perspective?

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

PR Review Comment: https://git.openjdk.org/jdk/pull/21625#discussion_r1848005273