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

[Adam Sotona]

On Thu, 12 Dec 2024 00:20:13 GMT, Chen Liang <liach at openjdk.org> wrote:

>> Improve documentation for constant pool entries.  This include some models for those entries, symbolic descriptors, and some general guidance in package summary.
>> 
>> APIDiff: https://cr.openjdk.org/~liach/apidiff/cf-consts/
>> Javadoc: https://cr.openjdk.org/~liach/javadoc/cf-consts/
>> 
>> Please review the associated CSR as well.
>> 
>> Companion PRs: #21625
>
> Chen Liang has updated the pull request with a new target base due to a merge or a rebase. The pull request now contains eight commits:
> 
>  - Minor cleanups
>  - Stage more doc changes
>  - Merge branch 'master' of https://github.com/openjdk/jdk into docs/cf-constantpool
>  - Merge branch 'master' of https://github.com/openjdk/jdk into docs/cf-constantpool
>  - Merge branch 'master' of https://github.com/openjdk/jdk into docs/cf-constantpool
>  - More concise message about exceptions
>  - Merge branch 'master' of https://github.com/openjdk/jdk into docs/cf-constantpool
>  - Improve api docs for constantpool

It is significant documentation improvement.
Great work!

src/java.base/share/classes/java/lang/classfile/BootstrapMethodEntry.java line 43:

> 41:  * method table is logically part of the constant pool.
> 42:  * <p>
> 43:  * Conceptually, a bootstrap method entry is a record:

Probably omitted "record" wording.

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

PR Review: https://git.openjdk.org/jdk/pull/22217#pullrequestreview-2501838193
PR Review Comment: https://git.openjdk.org/jdk/pull/22217#discussion_r1883635014