RFR: 8343239: Javadoc marks non-preview type as preview if it's the subtype of a preview type [v5]

Nizar Benalla nbenalla at openjdk.org
Wed Nov 27 15:36:51 UTC 2024


On Wed, 27 Nov 2024 09:58:18 GMT, Nizar Benalla <nbenalla at openjdk.org> wrote:

>> Please review this patch to improve the javadoc preview header. The parent bug include more details.
>> 
>> This is meant to prevent a bug where, if a non preview class extend an `@PreviewFeature` interface, the Javadoc displays `Programs can only use <<Type>> when preview features are enabled` when the API can be used without enable preview features as long as we don't refer to any methods in the supertype
>> 
>> This is specifically the case in  #17543. Here is the javadoc output [AsymmetricKey](https://cr.openjdk.org/~nbenalla/GeneratedDocs/8343239-2/docs/api/java.base/java/security/AsymmetricKey.html) after merging this branch with the PR `298420: PEM API: Implementation (Preview) #17543`. The only files affected by this change are the class `DEREncodable` and it's Subinterfaces.
>> 
>> One other bug I noticed is that, on the `DEREncodable` page, it's direct subinterfaces had the superscript `PREVIEW` link. I've added a condition to remove it.
>
> Nizar Benalla has updated the pull request incrementally with one additional commit since the last revision:
> 
>   Remove trailing whitespace attempt 2

Thank you for the reviews! I'm glad the final solution ended up being very simple.

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

PR Comment: https://git.openjdk.org/jdk/pull/22126#issuecomment-2504175320


More information about the javadoc-dev mailing list