Building JavaDoc and Sources JARs

[Daniel Zwolenski]

I've enabled that property and I now get a bunch of errors (100+), some
random samples:

/Users/zonski/Development/openjdk/jfx78/jfx78-zonski/jfx78/modules/web/src/main/java/javafx/scene/web/HTMLEditor.java:31:
error: package com.sun.javafx.scene.web.skin does not exist
import com.sun.javafx.scene.web.skin.HTMLEditorSkin;

/Users/zonski/Development/openjdk/jfx78/jfx78-zonski/jfx78/modules/swt/src/main/java/javafx/embed/swt/FXCanvas.java:186:
error: incorrect use of inline tag
     * @inheritDoc
       ^
/Users/zonski/Development/openjdk/jfx78/jfx78-zonski/jfx78/modules/graphics/src/main/java/javafx/scene/input/Clipboard.java:93:
error: end tag missing: </code>
 * <pre><code>

/Users/zonski/Development/openjdk/jfx78/jfx78-zonski/jfx78/modules/controls/src/main/java/javafx/scene/control/TableColumn.java:381:
error: reference not found
     * is the {@link PropertyValueFactory} class. Refer to this class for
more


I see properties talking about linking to the JavaDoc for the whole JDK
(which I'm now downloading). I will set this up but I don't think it's
going to solve most of those errors?


Some general feedback: Seems like a lot of hoops to jump through and magic
in the build still. I'm just trying to get some JavaDoc here, nothing
fancy. Apart from the errors working, it's not overly intuitive that I have
to set a BUILD_JAVADOC=true to make 'gradle javadoc' work - can't the
gradle command just force the jdoc to build? The gradle stuff is definitely
better than before but it's still not a check it out and get busy coding
setup, which I'm hoping is the eventual goal.

The IntelliJ project that comes down with it doesn't just open either. It
seems to be dependent on all the other JDK projects being there. I don't
know how Gradle works, but the Maven approach to this would be that all
your bits and pieces are stand-alone artefacts/modules with their own POM.
Each one could be built on their own (and the jar is then put in a repo)
and then they all just reference each other as needed. If you guys deployed
to repositories (literally a filesystem that follows a naming convention -
not that hard!) for your builds and deployed each of the modules, then
community developers could just reference these instead of having to build
and reference bits and pieces that they have no interest in.





On Fri, Jul 26, 2013 at 2:38 PM, Richard Bair <richard.bair at oracle.com>wrote:

> You gotta set the BUILD_JAVADOC flag. Look in gradle.properties.template
> -- all the different flags are pretty well documented there.
>
> For sources, somebody else posted a message about wanting to do that, and
> I think that's great. Just need to get a patch to the gradle build to
> create a source zip (per platform, or just one big zip with everything in
> it?)
>
> Richard
>
> On Jul 25, 2013, at 8:24 PM, Daniel Zwolenski <zonski at gmail.com> wrote:
>
> > For the Maven deploy I need a JAR of the JavaDoc and another containing
> the
> > sources. That's the rules.
> >
> > How do I build these with the Gradle build? I tried:
> >
> >> gradle javadoc
> >
> > and can't see any JavaDoc anywhere in the build directory?
> >
> > Admittedly I am running this on the 78 backport code, not the JFX code,
> but
> > I believe this part of the build should be the same?
> >
> > Full log:
> >
> > Daniels-MacBook-Pro:jfx78 zonski$ /usr/local/gradle-1.6/bin/gradle
> javadoc
> > The ConfigurationContainer.add() method has been deprecated and is
> > scheduled to be removed in Gradle 2.0. Please use the create() method
> > instead.
> > :buildSrc:clean UP-TO-DATE
> > :buildSrc:generateGrammarSource
> > error(10):  internal error: Can't get property indirectDelegates using
> > method get/isIndirectDelegates from org.antlr.tool.Grammar instance :
> > java.lang.NullPointerException
> > java.util.Objects.requireNonNull(Objects.java:203)
> > java.util.ArrayList.removeAll(ArrayList.java:674)
> >
> org.antlr.tool.CompositeGrammar.getIndirectDelegates(CompositeGrammar.java:222)
> > org.antlr.tool.Grammar.getIndirectDelegates(Grammar.java:2620)
> > sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
> >
> sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:57)
> >
> sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
> > java.lang.reflect.Method.invoke(Method.java:491)
> > org.antlr.stringtemplate.language.ASTExpr.invokeMethod(ASTExpr.java:563)
> >
> org.antlr.stringtemplate.language.ASTExpr.rawGetObjectProperty(ASTExpr.java:514)
> >
> org.antlr.stringtemplate.language.ASTExpr.getObjectProperty(ASTExpr.java:416)
> >
> org.antlr.stringtemplate.language.ActionEvaluator.attribute(ActionEvaluator.java:351)
> >
> org.antlr.stringtemplate.language.ActionEvaluator.expr(ActionEvaluator.java:136)
> >
> org.antlr.stringtemplate.language.ActionEvaluator.templateApplication(ActionEvaluator.java:216)
> >
> org.antlr.stringtemplate.language.ActionEvaluator.expr(ActionEvaluator.java:126)
> >
> org.antlr.stringtemplate.language.ActionEvaluator.action(ActionEvaluator.java:84)
> > org.antlr.stringtemplate.language.ASTExpr.write(ASTExpr.java:148)
> > org.antlr.stringtemplate.StringTemplate.write(StringTemplate.java:700)
> > org.antlr.stringtemplate.language.ASTExpr.write(ASTExpr.java:722)
> >
> org.antlr.stringtemplate.language.ASTExpr.writeAttribute(ASTExpr.java:659)
> >
> org.antlr.stringtemplate.language.ActionEvaluator.action(ActionEvaluator.java:86)
> > org.antlr.stringtemplate.language.ASTExpr.write(ASTExpr.java:148)
> > org.antlr.stringtemplate.StringTemplate.write(StringTemplate.java:700)
> > org.antlr.stringtemplate.language.ASTExpr.write(ASTExpr.java:722)
> >
> org.antlr.stringtemplate.language.ASTExpr.writeAttribute(ASTExpr.java:659)
> >
> org.antlr.stringtemplate.language.ActionEvaluator.action(ActionEvaluator.java:86)
> > org.antlr.stringtemplate.language.ASTExpr.write(ASTExpr.java:148)
> > org.antlr.stringtemplate.StringTemplate.write(StringTemplate.java:700)
> > org.antlr.stringtemplate.language.ASTExpr.write(ASTExpr.java:722)
> >
> org.antlr.stringtemplate.language.ASTExpr.writeAttribute(ASTExpr.java:659)
> >
> org.antlr.stringtemplate.language.ActionEvaluator.action(ActionEvaluator.java:86)
> > org.antlr.stringtemplate.language.ASTExpr.write(ASTExpr.java:148)
> > org.antlr.stringtemplate.StringTemplate.write(StringTemplate.java:700)
> > org.antlr.codegen.CodeGenerator.write(CodeGenerator.java:1278)
> > org.antlr.codegen.Target.genRecognizerFile(Target.java:94)
> > org.antlr.codegen.CodeGenerator.genRecognizer(CodeGenerator.java:463)
> > org.antlr.Tool.generateRecognizer(Tool.java:607)
> > org.antlr.Tool.process(Tool.java:429)
> > org.antlr.Tool.main(Tool.java:91)
> > :buildSrc:compileJava
> > :buildSrc:compileGroovy
> > :buildSrc:processResources
> > :buildSrc:classes
> > :buildSrc:jar
> > :buildSrc:assemble
> > :buildSrc:compileTestJava
> > Note:
> >
> /Users/zonski/Development/openjdk/jfx78/jfx78-zonski/jfx78/buildSrc/src/test/java/com/sun/scenario/effect/compiler/parser/FieldSelectTest.java
> > uses or overrides a deprecated API.
> > Note: Recompile with -Xlint:deprecation for details.
> > :buildSrc:compileTestGroovy UP-TO-DATE
> > :buildSrc:processTestResources UP-TO-DATE
> > :buildSrc:testClasses
> > :buildSrc:test
> > :buildSrc:check
> > :buildSrc:build
> > Missing or incorrect path to 'jfxrt.jar':
> >
> '/Library/Java/JavaVirtualMachines/jdk1.8.0.jdk/Contents/Home/jre/lib/ext/jfxrt.jar'.
> > Perhaps bad JDK_HOME?
> > /Library/Java/JavaVirtualMachines/jdk1.8.0.jdk/Contents/Home
> > Unsupported gradle version 1.6 in use. Only 1.4 is supported
> > OS_NAME: mac os x
> > OS_ARCH: x86_64
> > JAVA_HOME:
> /Library/Java/JavaVirtualMachines/jdk1.8.0.jdk/Contents/Home/jre
> > JDK_HOME: /Library/Java/JavaVirtualMachines/jdk1.8.0.jdk/Contents/Home
> > COMPILE_TARGETS: mac
> > COMPILE_FLAGS_FILES: buildSrc/mac.gradle
> > BINARY_STUB:
> >
> /Library/Java/JavaVirtualMachines/jdk1.8.0.jdk/Contents/Home/jre/lib/ext/jfxrt.jar
> > HUDSON_JOB_NAME: not_hudson
> > HUDSON_BUILD_NUMBER: 0000
> > PROMOTED_BUILD_NUMBER: 00
> > PRODUCT_NAME: OpenJFX
> > RAW_VERSION: 7.8.0
> > RELEASE_NAME: 7.8
> > RELEASE_MILESTONE: ea
> > UPDATE_STUB_CACHE: false
> > The CompileOptions.useAnt property has been deprecated and is scheduled
> to
> > be removed in Gradle 2.0. There is no replacement for this property.
> > :updateCacheIfNeeded UP-TO-DATE
> > :base:processVersionInfo
> > :base:compileJava
> > [ant:javac] Note:
> >
> /Users/zonski/Development/openjdk/jfx78/jfx78-zonski/jfx78/modules/base/src/main/java/com/sun/javafx/binding/SelectBinding.java
> > uses or overrides a deprecated API.
> > [ant:javac] Note: Recompile with -Xlint:deprecation for details.
> > [ant:javac] Note: Some input files use unchecked or unsafe operations.
> > [ant:javac] Note: Recompile with -Xlint:unchecked for details.
> > :base:processResources UP-TO-DATE
> > :base:classes
> > :base:jar
> > :graphics:compileJava
> > [ant:javac] Note: Some input files use or override a deprecated API.
> > [ant:javac] Note: Recompile with -Xlint:deprecation for details.
> > [ant:javac] Note: Some input files use unchecked or unsafe operations.
> > [ant:javac] Note: Recompile with -Xlint:unchecked for details.
> > :graphics:compilePrismCompilers
> > :graphics:generatePrismShaders
> > :graphics:compilePrismJavaShaders
> > :graphics:compileDecoraCompilers
> > :graphics:generateDecoraShaders
> > :graphics:compileDecoraHLSLShaders SKIPPED
> > :graphics:processDecoraShaders
> > :graphics:compilePrismHLSLShaders SKIPPED
> > :graphics:processPrismShaders
> > :graphics:processResources
> > :graphics:classes
> > :graphics:jar
> > :designTime:compileJava
> > [ant:javac] Note: Some input files use unchecked or unsafe operations.
> > [ant:javac] Note: Recompile with -Xlint:unchecked for details.
> > :designTime:processResources UP-TO-DATE
> > :designTime:classes
> > :designTime:jar
> > :controls:compileJava
> > [ant:javac] Note: Some input files use or override a deprecated API.
> > [ant:javac] Note: Recompile with -Xlint:deprecation for details.
> > [ant:javac] Note: Some input files use unchecked or unsafe operations.
> > [ant:javac] Note: Recompile with -Xlint:unchecked for details.
> > :controls:processResources
> > :controls:classes
> > :controls:jar
> > :swing:compileJava
> > [ant:javac] Note:
> >
> /Users/zonski/Development/openjdk/jfx78/jfx78-zonski/jfx78/modules/swing/src/main/java/javafx/embed/swing/SwingCursors.java
> > uses or overrides a deprecated API.
> > [ant:javac] Note: Recompile with -Xlint:deprecation for details.
> > [ant:javac] Note: Some input files use unchecked or unsafe operations.
> > [ant:javac] Note: Recompile with -Xlint:unchecked for details.
> > :swing:processResources UP-TO-DATE
> > :swing:classes
> > :swing:jar
> > :swt:compileJava
> > [ant:javac] Note: Some input files use unchecked or unsafe operations.
> > [ant:javac] Note: Recompile with -Xlint:unchecked for details.
> > :swt:processResources UP-TO-DATE
> > :swt:classes
> > :swt:jar
> > :fxml:compileJava
> > [ant:javac] Note:
> >
> /Users/zonski/Development/openjdk/jfx78/jfx78-zonski/jfx78/modules/fxml/src/main/java/javafx/fxml/FXMLLoader.java
> > uses unchecked or unsafe operations.
> > [ant:javac] Note: Recompile with -Xlint:unchecked for details.
> > :fxml:processResources UP-TO-DATE
> > :fxml:classes
> > :web:compileJava SKIPPED
> > :web:processResources
> > :web:classes
> > :javadoc SKIPPED
> > :apps:compileJava UP-TO-DATE
> > :apps:processResources UP-TO-DATE
> > :apps:classes UP-TO-DATE
> > :apps:javadoc SKIPPED
> > :base:javadoc SKIPPED
> > :web:copyClassesFromBinaryStub
> > The specified zip file ZIP
> >
> '/Library/Java/JavaVirtualMachines/jdk1.8.0.jdk/Contents/Home/jre/lib/ext/jfxrt.jar'
> > does not exist and will be silently ignored. This behaviour has been
> > deprecated and is scheduled to be removed in Gradle 2.0
> > :web:jar
> > :builders:compileJava
> > [ant:javac] Note: Some input files use unchecked or unsafe operations.
> > [ant:javac] Note: Recompile with -Xlint:unchecked for details.
> > :builders:processResources UP-TO-DATE
> > :builders:classes
> > :graphics:javadoc SKIPPED
> > :designTime:javadoc SKIPPED
> > :controls:javadoc SKIPPED
> > :swing:javadoc SKIPPED
> > :swt:javadoc SKIPPED
> > :web:javadoc SKIPPED
> > :builders:javadoc SKIPPED
> > :fxml:javadoc SKIPPED
> > :fxpackager:compileJava
> > [ant:javac] Note: Some input files use unchecked or unsafe operations.
> > [ant:javac] Note: Recompile with -Xlint:unchecked for details.
> > :fxpackager:man
> > :fxpackager:processResources
> > :fxpackager:classes
> > :fxpackager:javadoc SKIPPED
> > :apps:experiments:compileJava SKIPPED
> > :apps:experiments:processResources SKIPPED
> > :apps:experiments:classes SKIPPED
> > :apps:experiments:javadoc SKIPPED
> > :apps:samples:compileJava SKIPPED
> > :apps:samples:processResources SKIPPED
> > :apps:samples:classes SKIPPED
> > :apps:samples:javadoc SKIPPED
> > :apps:experiments:3DViewer:compileJava
> > [ant:javac] Note: Some input files use or override a deprecated API.
> > [ant:javac] Note: Recompile with -Xlint:deprecation for details.
> > [ant:javac] Note: Some input files use unchecked or unsafe operations.
> > [ant:javac] Note: Recompile with -Xlint:unchecked for details.
> > :apps:experiments:3DViewer:processResources
> > :apps:experiments:3DViewer:classes
> > :apps:experiments:3DViewer:javadoc SKIPPED
> > :apps:experiments:Modena:compileJava
> > [ant:javac] Note: Some input files use or override a deprecated API.
> > [ant:javac] Note: Recompile with -Xlint:deprecation for details.
> > [ant:javac] Note: Some input files use unchecked or unsafe operations.
> > [ant:javac] Note: Recompile with -Xlint:unchecked for details.
> > :apps:experiments:Modena:processResources
> > :apps:experiments:Modena:classes
> > :apps:experiments:Modena:javadoc SKIPPED
> > :apps:samples:Ensemble8:compileJava
> > [ant:javac] Note: Some input files use or override a deprecated API.
> > [ant:javac] Note: Recompile with -Xlint:deprecation for details.
> > [ant:javac] Note: Some input files use unchecked or unsafe operations.
> > [ant:javac] Note: Recompile with -Xlint:unchecked for details.
> > :apps:samples:Ensemble8:processResources
> > :apps:samples:Ensemble8:classes
> > :apps:samples:Ensemble8:javadoc SKIPPED
> >
> > BUILD SUCCESSFUL
> >
> > Total time: 3 mins 33.101 secs
>
>