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

[Chen Liang]

On Wed, 20 Nov 2024 23:03:43 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 incrementally with four additional commits since the last revision:
> 
>  - typo
>  - More cleanup
>  - Remove a few confusions around bad modeling, some missing exceptions, also the labelless info models
>  - Non-int constant values

I used the term "record" because they are something that may be pattern-matchable in the future; they are plain data objects. Similar representation is used in data model section of the java.lang.classfile package-level documentation.

Pushed another iteration (also updated CR) that solved some of the issues, including the constant format problems. I still think it is meaningful to move the huge data model from root package doc to individual model classes.

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

PR Comment: https://git.openjdk.org/jdk/pull/21625#issuecomment-2489710019