-
CSR
-
Resolution: Approved
-
P3
-
None
-
behavioral
-
minimal
-
The recently enhanced type-based detection for JavaFX properties significantly reduces the risk of false positives when detecting JavaFX properties.
-
add/remove/modify command line option
Summary
Enable -javafx
mode by default when JavaFX is determined to be available in the compilation environment.
Problem
Support for JavaFX (and JavaFX properties) was added to the standard doclet in javadoc in JDK 8. However, because of the name-based heuristics for detecting JavaFX properties, the support had to be explicitly enabled by the use of the doclet's -javafx
command-line option.Since then, there have been other improvements in the standard doclet, such as the rewrite of the internal VisibleMemberTable
in JDK-8025091. These improvements allow determination of JavaFX properties to be based on type information as well as name, such that the explicit use of the -javafx
option is no longer generally required.
Solution
Change the default value of the option to "on"/"true" when definitions of appropriate JavaFX modules and/or types are detected in the compilation environment used by the standard doclet to generate API docs.
The option is not removed at this point, to avoid breaking any user scripts that may explicitly set the option. In future releases, we may give warnings when the option is used unnecessarily, and eventually remove the option completely.
Specification
If the type javafx.beans.value.ObservableValue
is found in the compilation environment, JavaFX mode will be automatically enabled, as if the option -javafx
had been specified. If that type is found to be in a module, that module must be javafx.beans
.
- csr of
-
JDK-8208531 -javafx mode should be on by default when JavaFX is available
-
- Closed
-