[jdk16] Integrated: JDK-8258002: Update "type" terminology in generated docs
Jonathan Gibbons
jjg at openjdk.java.net
Fri Dec 18 18:39:00 UTC 2020
On Tue, 15 Dec 2020 01:42:30 GMT, Jonathan Gibbons <jjg at openjdk.org> wrote:
> This is the work to update javadoc to use certain terminology dependent on the source version in use.
>
> The groups of terms being changed are:
>
> * `Types` to `Classes and Interfaces`
> * `Annotation Type` to `Annotation Interface`
> * `Enum` to `Enum Class`
>
> The new terminology will be used when the source version of the elements being documented is 16 or higher. This is the default behavior. The corollary is that the old terminology will be used when the `--source` or `--release` option is used to specify a version less than `16`.
>
> In addition, the terminology for `Record` is being unconditionally changed to use `Record Class`. Since the feature was in preview before this release, there is no need to be able to generate the previous form.
>
> Also, in the course of this work, it was noted that on the "Use" page for an annotation type/interface, it was incorrectly classified as a *class*, instead of *annotation interface*: that has been fixed.
>
> Fundamentally, the change is managed at a very low level, by passing a _mapping function_ into `Resource.getText`. This allows high level code, `HtmlDoclet` in this case, to provide version-specific overrides of the resource key to be used. The avoids having to have version-specific checks at the point of use for each affected resource.
This pull request has now been integrated.
Changeset: c04c7e1f
Author: Jonathan Gibbons <jjg at openjdk.org>
URL: https://git.openjdk.java.net/jdk16/commit/c04c7e1f
Stats: 557 lines in 45 files changed: 317 ins; 46 del; 194 mod
8258002: Update "type" terminology in generated docs
Reviewed-by: hannesw
-------------
PR: https://git.openjdk.java.net/jdk16/pull/20
More information about the javadoc-dev
mailing list