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

Chen Liang liach at openjdk.org
Thu Jan 23 20:02:23 UTC 2025


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: Running 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

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

Commit messages:
 - Trailing whitespaces
 - Broken anchor, add critical option informaton
 - Use imports for classfile api intro
 - Years
 - Fixes, roll back package info
 - Merge branch 'master' of https://github.com/openjdk/jdk into docs/cf-overall
 - Merge remote-tracking branch 'openjdk/master' into docs/cf-overall
 - 8347762: ClassFile attribute specification refers to non-SE modules
 - CSR review remarks
 - Stage
 - ... and 2 more: https://git.openjdk.org/jdk/compare/605b53e4...d4b1c1ed

Changes: https://git.openjdk.org/jdk/pull/23277/files
  Webrev: https://webrevs.openjdk.org/?repo=jdk&pr=23277&range=00
  Issue: https://bugs.openjdk.org/browse/JDK-8342465
  Stats: 2945 lines in 37 files changed: 1936 ins; 30 del; 979 mod
  Patch: https://git.openjdk.org/jdk/pull/23277.diff
  Fetch: git fetch https://git.openjdk.org/jdk.git pull/23277/head:pull/23277

PR: https://git.openjdk.org/jdk/pull/23277


More information about the core-libs-dev mailing list