JDK-8096595 : Javadoc documents methods annotated with @treatAsPrivate on an open build
  • Type: Bug
  • Component: javafx
  • Sub-Component: build
  • Affected Version: 8u11
  • Priority: P4
  • Status: Resolved
  • Resolution: Cannot Reproduce
  • Submitted: 2014-08-01
  • Updated: 2015-06-12
  • Resolved: 2014-08-01
Related Reports
Relates :  
JDK-8089509 - Javadoc of custom controls shows links to impl_* methods of its JavaFX superclasses
Description
In the official JavaFX docs at http://docs.oracle.com/javase/8/javafx/api/ methods whose documentation is annotated with @treatAsPrivate tag are not displayed. But running javadoc on a open build creates a documentation containing these methods.

Maybe the official documentation is created by using some custom doclet which is not part of JDK/OpenJFX?
Comments
Ths "-javafx" option should have been documented in JDK 8 but the omission was noticed too late. The following JDK bug (which for some reason is marked Confidential) is tracking this. https://bugs.openjdk.java.net/browse/JDK-8034883 It is fixed in the upcoming 8u20 release.
01-08-2014
I built the javadoc using: gradle -PBUILD_JAVADOC=true javadoc I realize now that I was looking for the documentation in the wrong place. I looked for the documentation of the Control class in 'rt/modules/controls/build/docs/javadoc/javafx/scene/control/' folder (which showed methods annotated with @treatAsPrivate) but in fact I should have looked under 'rt/build/javadoc/javafx/scene/control/' folder which shows the documentation correctly. By the way, which "-javafx" option are you talking about? As far as I know this option is not yet documentated: http://docs.oracle.com/javase/8/docs/technotes/tools/unix/javadoc.html#CHDIEIIB
01-08-2014
I just did a test build of the docs using: gradle -PBUILD_JAVADOC=true sdk and the correct doclet options are used. The methods and fields annotated with @treatAsPrivate do not show up in the docs.
01-08-2014
The "-javafx" option is what enables recognizing @treatAsPrivate and as far as I can tell, that option is specified when you are building from the openjfx repo. How did you build the javadoc? Using "gradle -PBUILD_JAVADOC=true sdk" or some other way?
01-08-2014