JDK-8314590 : ☂ Eliminate all javadoc warnings in JavaFX
  • Type: Task
  • Component: javafx
  • Sub-Component: other
  • Priority: P4
  • Status: Resolved
  • Resolution: Delivered
  • Submitted: 2023-08-18
  • Updated: 2024-03-05
  • Resolved: 2024-03-05
The Version table provides details related to the release that this issue/RFE will be addressed.

Unresolved : Release in which this issue/RFE will be addressed.
Resolved: Release in which this issue/RFE has been resolved.
Fixed : Release in which this issue/RFE has been fixed. The release containing this fix may be available for download as an Early Access Release or a General Availability Release.

To download the current JDK release, click here.
Other
jfx23Resolved
Related Reports
Blocks :  
JDK-8325075 - Enable -Werror for javadoc to fail on any warnings
Blocks :  
JDK-8270996 - javadoc: missing comments in serialized classes
Blocks :  
JDK-8271083 - ☂ Missing documentation in JavaFX API
Blocks :  
JDK-8314597 - Deprecate for removal protected access methods in converters
Blocks :  
JDK-8325073 - javadoc warnings: missing @param tags and other issues
Blocks :  
JDK-8314589 - javadoc build only shows the first 100 warnings and errors
Relates :  
JDK-8325071 - javadoc generates incorrect missing comment warning in one case for JavaFX property
Relates :  
JDK-8324783 - Fix javadoc issues reported by Eclipse
Description
This is an umbrella task to track the elimination of javadoc warnings when generating the JavaFX API docs. Those warnings that result in missing documentation are already tracked by JDK-8271083 (whose only remaining unresolved linked blocking issue is JDK-8270996).

I will file linked blocking bugs of *this* JBS Task for the remaining issues. I will also list JDK-8271083 and a linked blocking issue of this Task.
Comments
All blocking tasks are resolved, so marking this umbrella task as "Delivered".
05-03-2024
The latest version is attached as "build-javadoc-1.log". There are a total of 186 warnings today, when using JDK 21 as the boot JDK. JDK-8270996 : tracking 91 warnings due to missing docs in serializable classes JDK-8325073 : tracking the remaining 95 warnings
31-01-2024
Once all warnings are fixed, we should consider a build change to treat all warnings as errors.
18-08-2023
See the attached file "build-javadoc.log". It was generated using JDK 21 RC as the boot JDK, running it on the current jfx master branch with the patch for JDK-8314589 (so we get all warnings instead of just the first 100).
18-08-2023