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

Nizar Benalla nbenalla at openjdk.org
Wed Nov 27 09:52:12 UTC 2024


> 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 with a new target base due to a merge or a rebase. The pull request now contains nine commits:

 - Trailing whitespace
 - Chen's suggestion and update test after preview superscript update
 - Merge remote-tracking branch 'upstream/master' into javadoc-preview-message
   
   # Conflicts:
   #	test/langtools/jdk/javadoc/doclet/testPreview/TestPreview.java
 - Changed based on Hannes' changes
 - dropping earlier idea/message as non-preview class should not have a preview message. As you do not need --enable-preview to use them.
   
   Removed some code and modified test accordingly
 - Merge remote-tracking branch 'upstream/master' into javadoc-preview-message
 - remove unused import
 - improve preview label message
 - fix preview bug

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

Changes: https://git.openjdk.org/jdk/pull/22126/files
  Webrev: https://webrevs.openjdk.org/?repo=jdk&pr=22126&range=03
  Stats: 62 lines in 2 files changed: 58 ins; 1 del; 3 mod
  Patch: https://git.openjdk.org/jdk/pull/22126.diff
  Fetch: git fetch https://git.openjdk.org/jdk.git pull/22126/head:pull/22126

PR: https://git.openjdk.org/jdk/pull/22126


More information about the javadoc-dev mailing list