RFR: JDK-8259806: Clean up terminology on the "All Classes" page
Jonathan Gibbons
jonathan.gibbons at oracle.com
Sat Jun 5 19:16:21 UTC 2021
Up until recently, we used
Types (now Classes and Interfaces)
Annotation Type (now Annotation Interface)
Enum (now Enum Class)
Record (now Record Class)
The general decision has been to use the older terms consistent with the
usage throughout the documentation for the older releases.
I guess you have a corner case here, where you are fixing "Classes"
(IIRC) and I guess it is "weird" to be retroactively changing it to
deprecated terminology like "Types" even if it would be more consistent,
especially when the new term is more accurate even for older releases.
-- Jon
On 6/4/21 11:57 PM, Hannes Wallnöfer wrote:
> On Thu, 3 Jun 2021 17:09:21 GMT, Jonathan Gibbons <jjg at openjdk.org> wrote:
>
>> Maybe I'm fighting a losing battle on this one, but the current policy is to generate the correct new terminology for recent releases and the older terminology for older releases, to try and stay consist within the release.
>>
>> The mapping is handled semi-automatically in `HtmlDoclet.getResourceKeyMapper`, line 130. As a general rule, if you're changing terminology, you should at least be updating the mapping as well.
> Is "Classes and Interfaces" part of the "new terminology"? I thought "classes and interfaces" would be the correct term for anything living in a .class file, regardless of release.
>
> -------------
>
> PR: https://git.openjdk.java.net/jdk/pull/4270
More information about the javadoc-dev
mailing list