RFR: 8342465: Improve API documentation for java.lang.classfile [v2]

[Chen Liang]

On Fri, 24 Jan 2025 22:42:27 GMT, Chen Liang <liach at openjdk.org> wrote:

>> This is the last piece in the API documentation improvement of the Class-File API.
>> 
>> This includes general documentation about transforms, models (and traversals), options, constants, and CodeBuilder factories.  In particular, this preserves the package summary to avoid extra disruptions.  See the APIDiff for more details.
>> 
>> Please forgive this messy commit history; the work began before attribute changes were integrated and based off that, and in the process there were a few merges back and forth.
>> The files changed/webrev should be reliable.
>> 
>> Please review the associated CSR as well.
>> 
>> Note that this intends to be backported to 24; this won't be clean, as the `JAVA_25_VERSION` constant is a new addition that does not exist on 24.
>> 
>> Testing: Tier 1-3.
>> 
>> APIDiff: https://cr.openjdk.org/~liach/apidiff/cf-overall/java.base/java/lang/classfile/package-summary.html
>> Javadoc: https://cr.openjdk.org/~liach/javadoc/cf-overall/java.base/java/lang/classfile/package-summary.html
>
> Chen Liang has updated the pull request incrementally with one additional commit since the last revision:
> 
>   Better specification of range of u2 values, flag masks and versions

>From the CSR review, an update is made to better describe the u2 values: that the returned int is not itself an unsigned short, but it is in the range of unsigned short, and gives out the exact range in decimal for versions and in hexadecimal for flags.  The CR previews have been updated.

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

PR Comment: https://git.openjdk.org/jdk/pull/23277#issuecomment-2613563995