RFR: 8341100: Add index entries for terms used in java.lang.Class

Chen Liang liach at openjdk.org
Sat Sep 28 19:25:38 UTC 2024


On Sat, 28 Sep 2024 14:56:37 GMT, Joe Darcy <darcy at openjdk.org> wrote:

> Small update to java.lang.Class docs.
> 
> I didn't add an index item for "hidden classes" since the indexing mechanism picks up the section titles.

Confirmed that searching for "hidden class" finds the "Hidden Classes" section in JDK 23 API docs.

src/java.base/share/classes/java/lang/Class.java line 144:

> 142:  * It is also possible to get the {@code Class} object for a named
> 143:  * class or interface (or for {@code void}) using a <dfn>class literal</dfn>
> 144:  * (JLS  {@jls 15.8.2}).

Suggestion:

 * (JLS {@jls 15.8.2}).

Also, the preexisting description of "class or interface" as represented by `java.lang.Class` is incorrect; it also represents primitive types, including void, and array types. But this problem exists in the first-sentence summary as well, so I believe we should fix it in another RFE.

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

Marked as reviewed by liach (Reviewer).

PR Review: https://git.openjdk.org/jdk/pull/21241#pullrequestreview-2335402043
PR Review Comment: https://git.openjdk.org/jdk/pull/21241#discussion_r1779740777


More information about the core-libs-dev mailing list