JDK-8271460 : Missing summary in javadoc comments in JavaFX modules
  • Type: Bug
  • Component: javafx
  • Sub-Component: other
  • Affected Version: jfx17
  • Priority: P4
  • Status: Open
  • Resolution: Unresolved
  • OS: generic
  • CPU: generic
  • Submitted: 2021-07-29
  • Updated: 2024-03-12
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
tbdUnresolved
Related Reports
Relates :  
JDK-8250590 - Classes and methods in the javafx.css package are missing documentation
Description
In all javafx modules there are places where there is a javadoc comment without summary.
This missed summary does not get highlighted as javadoc build warning or error.

Use "find in files" in any text editor - to look for -
Search 1 : 
"/**
     * @return"
and

Search 2 :
"/** @return"

Search 1 results : 173 matches across 111 files
Search 2 results : 21 matches across 12 files


All these methods should have javadoc summary added to it along with existing @return statement.
Comments
Numbers mentioned in the Bug description included (rather incorrectly) some files in the third party code (icu lib) I did a search in *.java files today. Here are the numbers - Note - please do a search excluding double quotes Search 1 : 56 matches across 27 files "/** * @return" Search 2 : 0 matches "/** @return"
12-03-2024
[~aghaisas] Was that search limited to publicly exported Java classes? We generate API docs, via javadoc, for classes under modules/javafx.*/src/main/java/javafx/** (specifically, we exclude anything under .../src/main/java/com/**).
12-03-2024
Good question. It might no longer be true, but needs to be verified (I wouldn't rely on an IDE for the verification).
11-03-2024
is this still true? a simple search in the IDE shows 0 matches. search query in eclipse: `\/\**@return`
11-03-2024
This needs to be re-evaluated after fixes of bugs linked to JDK-8271083.
07-12-2021