RFR: 8342465: Improve API documentation for java.lang.classfile

Adam Sotona asotona at openjdk.org
Fri Jan 24 15:01:47 UTC 2025


On Thu, 23 Jan 2025 19:48:55 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

Great job, thank you!

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

Marked as reviewed by asotona (Reviewer).

PR Review: https://git.openjdk.org/jdk/pull/23277#pullrequestreview-2572145988


More information about the core-libs-dev mailing list