JDK-8114290 : Wrong links in Javadoc of builders
  • Type: Bug
  • Component: docs
  • Sub-Component: javafx
  • Affected Version: fx2.0
  • Priority: P3
  • Status: Resolved
  • Resolution: Fixed
  • Submitted: 2011-08-10
  • Updated: 2015-06-16
  • Resolved: 2011-10-04
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.
JDK 7
7-poolFixed
Related Reports
Blocks :  
JDK-8092662 - Identify and fix all broken JavaDoc links
Description
The Javadoc generated from builders sources contains broken links to nonexistent properties. E.g. there is no opacityProperty in Color and yet the ColorBuilder references it in opacity(double) javadoc. Complete list of cases is in the attached file. 

The javadoc doclet doesn't create links in these broken cases but it is worth fixing it to allow the developers to find the addressed field or setter more easily.
Comments
Applied the given patch in 2.0.2. changeset: 14605:62da1891616e user: emcmanus date: Tue Oct 04 15:46:50 2011 +0200
04-10-2011
SQE - can we generate builders code and builders javadoc separately? So that changes are isolated and do not affect code? If not - let's defer
31-08-2011
I am suggesting deferring this bug because it involves a non-trivial (though not huge) change to builder generation. To summarize the problem, we get warnings during javadoc generation and the javadoc text says just e.g. "the opacity property" instead of "the _opacity_ property" with a link to the property itself. Users are very unlikely to notice; the main problem for us is that it makes it impossible to get a clean warning-less javadoc build. I do have a fix if we consider that the risk of changing anything at this stage is outweighed by the advantage of a clean javadoc build.
30-08-2011
Please, ask for deferral in this case as soon as possible.
30-08-2011
The attached patch fixes the problem by linking to the getFoo() or isFoo() method rather than the fooProperty() method. However, it is not a doc-only change so I think it is probably too late to include it in the initial Presidio release.
24-08-2011