RFR: 8339329: ConstantPoolBuilder#constantValueEntry method doc typo and clarifications

[Chen Liang]

On Fri, 30 Aug 2024 15:08:20 GMT, David M. Lloyd <duke at openjdk.org> wrote:

> Please review this small documentation change to ConstantPoolBuilder to fix a typo and clarify the usage of the `constantValueEntry` method.

src/java.base/share/classes/java/lang/classfile/constantpool/ConstantPoolBuilder.java line 479:

> 477:      * {@return A {@link ConstantValueEntry} describing the provided
> 478:      * Integer, Long, Float, Double, or String constant}
> 479:      * The returned consant is suitable as a value for the

This information is already available on `ConstantValueEntry`. Since we already link to it on the return type, I feel like this is a redundancy.

However, `ConstantValueEntry::constantValue()` is missing a link to this API; would be nice if you can add that. And `ConstantValueEntry` is missing a link to `Attributes::constantValue()` too.

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

PR Review Comment: https://git.openjdk.org/jdk/pull/20796#discussion_r1739164493