[jira] [Commented] (NETBEANS-3296) Attaching JavaFX Javadoc and Sources
[
https://issues.apache.org/jira/browse/NETBEANS-3296?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16969562#comment-16969562
]
Laszlo Kishalmi commented on NETBEANS-3296:
---
Well it seems Thomas fixed the javadoc issue for all java project types. That
will make Gradle projects work as well.
> Attaching JavaFX Javadoc and Sources
>
>
> Key: NETBEANS-3296
> URL: https://issues.apache.org/jira/browse/NETBEANS-3296
> Project: NetBeans
> Issue Type: Bug
>Affects Versions: 11.2
> Environment: OpenJDK 13.0.1 on Ubuntu 16.04.6 LTS
>Reporter: John Neffenger
>Priority: Major
> Attachments: ant-JAVAFX13-classpath.png, ant-JAVAFX13-javadoc.png,
> ant-JAVAFX13-sources.png, ant-JavaFX13-classpath.png,
> ant-JavaFXMODS13-classpath.png, ant-cannot-use-elements-1.png,
> ant-cannot-use-elements-2.png, ant-command-run.png,
> ant-compile-classpath.png, ant-compile-modulepath.png,
> ant-completion-fails.png, ant-completion-works-1.png,
> ant-completion-works-2.png, ant-edit-jar-reference.png,
> ant-install-nb-javac.png, ant-invalid-javadoc-root.png,
> ant-javadoc-fails.png, ant-source-fails-1.png, ant-source-fails-2.png,
> ant-source-works-1.png, ant-source-works-2.png, ant-try-with-resources.png,
> gradle-completion-fails.png, gradle-completion-works.png,
> gradle-distribution.png, gradle-javadoc-fails.png, gradle-source-works.png,
> java-javadoc-works.png, java-platform-javadoc.png,
> maven-completion-fails.png, maven-dependencies.png, maven-source-fails.png
>
>
> h1. {anchor:attaching-javafx-javadoc-and-sources}Attaching JavaFX Javadoc and
> Sources
> I have been unable to attach the JavaFX Javadoc and Sources to their modular
> JAR files without encountering errors in their use by NetBeans. Attaching the
> Sources allows you to navigate directly to the JavaFX source code of a field
> or method. Attaching the Javadoc allows you to open an external Web browser
> directly to the appropriate page of the documentation. These features are two
> of the main reasons I use an integrated development environment.
> There are several issues encountered in this task, making it easy to lose
> sight of the bigger picture. This is my attempt to provide that more general
> context and gather all the related issues into one place.
> h2. {anchor:issues}Issues
> Some of the problems related to using the JavaFX Javadoc and Sources have
> already been reported:
> * [NETBEANS-236|https://issues.apache.org/jira/browse/NETBEANS-236]:
> Incorrect brace spacing in try-with-resources
> * [NETBEANS-1396|https://issues.apache.org/jira/browse/NETBEANS-1396]: Maven:
> Downloaded javadoc / sources not attached to artifact with classifier
> * [NETBEANS-2197|https://issues.apache.org/jira/browse/NETBEANS-2197]:
> Missing code completion and Javadocs in maven projects with classifier
> * [NETBEANS-2290|https://issues.apache.org/jira/browse/NETBEANS-2290]:
> nb-javac 1.71 fails to parse JavaFX Sources
> The two issues concerning Maven projects will be fixed by the following pull
> request (a work in progress):
> * [apache/netbeans#1548|https://github.com/apache/netbeans/pull/1548]:
> (NETBEANS-1396) Missing code completion and Javadocs in maven projects with
> classifier
> I created the following issues for the new problems described here:
> * [NETBEANS-3297|https://issues.apache.org/jira/browse/NETBEANS-3297]:
> "Attach Javadoc" really means "Attach Sources"
> * [NETBEANS-3298|https://issues.apache.org/jira/browse/NETBEANS-3298]:
> Invalid Javadoc root javafx-sdk-13/doc/javafx.base
> * [NETBEANS-3299|https://issues.apache.org/jira/browse/NETBEANS-3299]: Adding
> Javadoc and Sources to Global Library fails
> * [NETBEANS-3300|https://issues.apache.org/jira/browse/NETBEANS-3300]:
> nb-javac 2.0 fails to parse JavaFX Sources
> * [NETBEANS-3301|https://issues.apache.org/jira/browse/NETBEANS-3301]:
> Modular Ant project fails to run without nb-javac
> * [NETBEANS-3302|https://issues.apache.org/jira/browse/NETBEANS-3302]:
> Non-modular Gradle project fails to recognize Javadoc
> * [NETBEANS-3303|https://issues.apache.org/jira/browse/NETBEANS-3303]:
> Modular Gradle project fails to recognize Javadoc and Sources
> There are also related issues for the JavaFX Javadoc and sample NetBeans
> projects on GitHub:
> * [openjfx/javadoc#6|https://github.com/openjfx/javadoc/issues/6]: Attached
> Javadoc does not follow Maven convention
> * [openjfx/samples#39|https://github.com/openjfx/samples/issues/39]:
> IllegalStateException running NetBeans Modular Maven project
> Each issue is listed again at the point where it's encountered below.
> h2. {anchor:projects}Projects
> I use the six sample NetBeans projects described in [Getting Started with
> JavaFX 13|https://openjfx.io/openjfx-docs/] to explain what goes wrong. I
>
[jira] [Commented] (NETBEANS-3296) Attaching JavaFX Javadoc and Sources
[
https://issues.apache.org/jira/browse/NETBEANS-3296?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16969539#comment-16969539
]
John Neffenger commented on NETBEANS-3296:
--
I did some initial tests of the [pull
request|https://github.com/apache/netbeans/pull/1548] for NETBEANS-1396 and
posted my [test
results|https://github.com/apache/netbeans/pull/1548#issuecomment-551237510] as
a comment. Can the techniques that Thomas is using to display the Javadoc in
Maven projects help in Gradle projects, too?
> Attaching JavaFX Javadoc and Sources
>
>
> Key: NETBEANS-3296
> URL: https://issues.apache.org/jira/browse/NETBEANS-3296
> Project: NetBeans
> Issue Type: Bug
>Affects Versions: 11.2
> Environment: OpenJDK 13.0.1 on Ubuntu 16.04.6 LTS
>Reporter: John Neffenger
>Priority: Major
> Attachments: ant-JAVAFX13-classpath.png, ant-JAVAFX13-javadoc.png,
> ant-JAVAFX13-sources.png, ant-JavaFX13-classpath.png,
> ant-JavaFXMODS13-classpath.png, ant-cannot-use-elements-1.png,
> ant-cannot-use-elements-2.png, ant-command-run.png,
> ant-compile-classpath.png, ant-compile-modulepath.png,
> ant-completion-fails.png, ant-completion-works-1.png,
> ant-completion-works-2.png, ant-edit-jar-reference.png,
> ant-install-nb-javac.png, ant-invalid-javadoc-root.png,
> ant-javadoc-fails.png, ant-source-fails-1.png, ant-source-fails-2.png,
> ant-source-works-1.png, ant-source-works-2.png, ant-try-with-resources.png,
> gradle-completion-fails.png, gradle-completion-works.png,
> gradle-distribution.png, gradle-javadoc-fails.png, gradle-source-works.png,
> java-javadoc-works.png, java-platform-javadoc.png,
> maven-completion-fails.png, maven-dependencies.png, maven-source-fails.png
>
>
> h1. {anchor:attaching-javafx-javadoc-and-sources}Attaching JavaFX Javadoc and
> Sources
> I have been unable to attach the JavaFX Javadoc and Sources to their modular
> JAR files without encountering errors in their use by NetBeans. Attaching the
> Sources allows you to navigate directly to the JavaFX source code of a field
> or method. Attaching the Javadoc allows you to open an external Web browser
> directly to the appropriate page of the documentation. These features are two
> of the main reasons I use an integrated development environment.
> There are several issues encountered in this task, making it easy to lose
> sight of the bigger picture. This is my attempt to provide that more general
> context and gather all the related issues into one place.
> h2. {anchor:issues}Issues
> Some of the problems related to using the JavaFX Javadoc and Sources have
> already been reported:
> * [NETBEANS-236|https://issues.apache.org/jira/browse/NETBEANS-236]:
> Incorrect brace spacing in try-with-resources
> * [NETBEANS-1396|https://issues.apache.org/jira/browse/NETBEANS-1396]: Maven:
> Downloaded javadoc / sources not attached to artifact with classifier
> * [NETBEANS-2197|https://issues.apache.org/jira/browse/NETBEANS-2197]:
> Missing code completion and Javadocs in maven projects with classifier
> * [NETBEANS-2290|https://issues.apache.org/jira/browse/NETBEANS-2290]:
> nb-javac 1.71 fails to parse JavaFX Sources
> The two issues concerning Maven projects will be fixed by the following pull
> request (a work in progress):
> * [apache/netbeans#1548|https://github.com/apache/netbeans/pull/1548]:
> (NETBEANS-1396) Missing code completion and Javadocs in maven projects with
> classifier
> I created the following issues for the new problems described here:
> * [NETBEANS-3297|https://issues.apache.org/jira/browse/NETBEANS-3297]:
> "Attach Javadoc" really means "Attach Sources"
> * [NETBEANS-3298|https://issues.apache.org/jira/browse/NETBEANS-3298]:
> Invalid Javadoc root javafx-sdk-13/doc/javafx.base
> * [NETBEANS-3299|https://issues.apache.org/jira/browse/NETBEANS-3299]: Adding
> Javadoc and Sources to Global Library fails
> * [NETBEANS-3300|https://issues.apache.org/jira/browse/NETBEANS-3300]:
> nb-javac 2.0 fails to parse JavaFX Sources
> * [NETBEANS-3301|https://issues.apache.org/jira/browse/NETBEANS-3301]:
> Modular Ant project fails to run without nb-javac
> * [NETBEANS-3302|https://issues.apache.org/jira/browse/NETBEANS-3302]:
> Non-modular Gradle project fails to recognize Javadoc
> * [NETBEANS-3303|https://issues.apache.org/jira/browse/NETBEANS-3303]:
> Modular Gradle project fails to recognize Javadoc and Sources
> There are also related issues for the JavaFX Javadoc and sample NetBeans
> projects on GitHub:
> * [openjfx/javadoc#6|https://github.com/openjfx/javadoc/issues/6]: Attached
> Javadoc does not follow Maven convention
> * [openjfx/samples#39|https://github.com/openjfx/samples/issues/39]:
> IllegalStateException running NetBeans Modular Maven project
> Each issue is listed again at the point where
[jira] [Commented] (NETBEANS-3296) Attaching JavaFX Javadoc and Sources
[
https://issues.apache.org/jira/browse/NETBEANS-3296?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16969435#comment-16969435
]
Laszlo Kishalmi commented on NETBEANS-3296:
---
I do not know what happened with my Gradle last night. First it started to
give back partial results on binaries, sources and javadocs, though it listed
both the platform and the general binaries, which is good. I've requested a
dependency insight on some dependencies. I do not know if that's related but
since then Gradle reports back just exacly what is desired the two binaries
source and javadoc references as well. I'm bit confused now.
I did some changes make the whole process more reliable in either case. I'm
still testing it.
On the other hand the javadoc packaging seems to be odd. Every javadoc package
contains the full javadoc of the openjfx project. Testing helloFX the IDE finds
the javadoc jar, but it looks for the root level for the documentation as: //.html instead of ///.html
> Attaching JavaFX Javadoc and Sources
>
>
> Key: NETBEANS-3296
> URL: https://issues.apache.org/jira/browse/NETBEANS-3296
> Project: NetBeans
> Issue Type: Bug
>Affects Versions: 11.2
> Environment: OpenJDK 13.0.1 on Ubuntu 16.04.6 LTS
>Reporter: John Neffenger
>Priority: Major
> Attachments: ant-JAVAFX13-classpath.png, ant-JAVAFX13-javadoc.png,
> ant-JAVAFX13-sources.png, ant-JavaFX13-classpath.png,
> ant-JavaFXMODS13-classpath.png, ant-cannot-use-elements-1.png,
> ant-cannot-use-elements-2.png, ant-command-run.png,
> ant-compile-classpath.png, ant-compile-modulepath.png,
> ant-completion-fails.png, ant-completion-works-1.png,
> ant-completion-works-2.png, ant-edit-jar-reference.png,
> ant-install-nb-javac.png, ant-invalid-javadoc-root.png,
> ant-javadoc-fails.png, ant-source-fails-1.png, ant-source-fails-2.png,
> ant-source-works-1.png, ant-source-works-2.png, ant-try-with-resources.png,
> gradle-completion-fails.png, gradle-completion-works.png,
> gradle-distribution.png, gradle-javadoc-fails.png, gradle-source-works.png,
> java-javadoc-works.png, java-platform-javadoc.png,
> maven-completion-fails.png, maven-dependencies.png, maven-source-fails.png
>
>
> h1. {anchor:attaching-javafx-javadoc-and-sources}Attaching JavaFX Javadoc and
> Sources
> I have been unable to attach the JavaFX Javadoc and Sources to their modular
> JAR files without encountering errors in their use by NetBeans. Attaching the
> Sources allows you to navigate directly to the JavaFX source code of a field
> or method. Attaching the Javadoc allows you to open an external Web browser
> directly to the appropriate page of the documentation. These features are two
> of the main reasons I use an integrated development environment.
> There are several issues encountered in this task, making it easy to lose
> sight of the bigger picture. This is my attempt to provide that more general
> context and gather all the related issues into one place.
> h2. {anchor:issues}Issues
> Some of the problems related to using the JavaFX Javadoc and Sources have
> already been reported:
> * [NETBEANS-236|https://issues.apache.org/jira/browse/NETBEANS-236]:
> Incorrect brace spacing in try-with-resources
> * [NETBEANS-1396|https://issues.apache.org/jira/browse/NETBEANS-1396]: Maven:
> Downloaded javadoc / sources not attached to artifact with classifier
> * [NETBEANS-2197|https://issues.apache.org/jira/browse/NETBEANS-2197]:
> Missing code completion and Javadocs in maven projects with classifier
> * [NETBEANS-2290|https://issues.apache.org/jira/browse/NETBEANS-2290]:
> nb-javac 1.71 fails to parse JavaFX Sources
> The two issues concerning Maven projects will be fixed by the following pull
> request (a work in progress):
> * [apache/netbeans#1548|https://github.com/apache/netbeans/pull/1548]:
> (NETBEANS-1396) Missing code completion and Javadocs in maven projects with
> classifier
> I created the following issues for the new problems described here:
> * [NETBEANS-3297|https://issues.apache.org/jira/browse/NETBEANS-3297]:
> "Attach Javadoc" really means "Attach Sources"
> * [NETBEANS-3298|https://issues.apache.org/jira/browse/NETBEANS-3298]:
> Invalid Javadoc root javafx-sdk-13/doc/javafx.base
> * [NETBEANS-3299|https://issues.apache.org/jira/browse/NETBEANS-3299]: Adding
> Javadoc and Sources to Global Library fails
> * [NETBEANS-3300|https://issues.apache.org/jira/browse/NETBEANS-3300]:
> nb-javac 2.0 fails to parse JavaFX Sources
> * [NETBEANS-3301|https://issues.apache.org/jira/browse/NETBEANS-3301]:
> Modular Ant project fails to run without nb-javac
> * [NETBEANS-3302|https://issues.apache.org/jira/browse/NETBEANS-3302]:
> Non-modular Gradle project fails to recognize Javadoc
> *
[jira] [Commented] (NETBEANS-3296) Attaching JavaFX Javadoc and Sources
[
https://issues.apache.org/jira/browse/NETBEANS-3296?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16968931#comment-16968931
]
Laszlo Kishalmi commented on NETBEANS-3296:
---
Well not really. The cleanest Gradle solution would be probably an overkill, I
did not make any experiments with it yet, but theoretically Gradle can publish
more than one jar for a module. So if anyone would experiment with that I;d try
to publish Gradle specific modules with the platform specific and the platform
independent sources together.
Right now I'd just add some openjfx specific heuristics in the NetBeans code in
order to get this working. I do not expect too many projects would came up with
such a solution, and let's wait for public JMOD-s.
> Attaching JavaFX Javadoc and Sources
>
>
> Key: NETBEANS-3296
> URL: https://issues.apache.org/jira/browse/NETBEANS-3296
> Project: NetBeans
> Issue Type: Bug
>Affects Versions: 11.2
> Environment: OpenJDK 13.0.1 on Ubuntu 16.04.6 LTS
>Reporter: John Neffenger
>Priority: Major
> Attachments: ant-JAVAFX13-classpath.png, ant-JAVAFX13-javadoc.png,
> ant-JAVAFX13-sources.png, ant-JavaFX13-classpath.png,
> ant-JavaFXMODS13-classpath.png, ant-cannot-use-elements-1.png,
> ant-cannot-use-elements-2.png, ant-command-run.png,
> ant-compile-classpath.png, ant-compile-modulepath.png,
> ant-completion-fails.png, ant-completion-works-1.png,
> ant-completion-works-2.png, ant-edit-jar-reference.png,
> ant-install-nb-javac.png, ant-invalid-javadoc-root.png,
> ant-javadoc-fails.png, ant-source-fails-1.png, ant-source-fails-2.png,
> ant-source-works-1.png, ant-source-works-2.png, ant-try-with-resources.png,
> gradle-completion-fails.png, gradle-completion-works.png,
> gradle-distribution.png, gradle-javadoc-fails.png, gradle-source-works.png,
> java-javadoc-works.png, java-platform-javadoc.png,
> maven-completion-fails.png, maven-dependencies.png, maven-source-fails.png
>
>
> h1. {anchor:attaching-javafx-javadoc-and-sources}Attaching JavaFX Javadoc and
> Sources
> I have been unable to attach the JavaFX Javadoc and Sources to their modular
> JAR files without encountering errors in their use by NetBeans. Attaching the
> Sources allows you to navigate directly to the JavaFX source code of a field
> or method. Attaching the Javadoc allows you to open an external Web browser
> directly to the appropriate page of the documentation. These features are two
> of the main reasons I use an integrated development environment.
> There are several issues encountered in this task, making it easy to lose
> sight of the bigger picture. This is my attempt to provide that more general
> context and gather all the related issues into one place.
> h2. {anchor:issues}Issues
> Some of the problems related to using the JavaFX Javadoc and Sources have
> already been reported:
> * [NETBEANS-236|https://issues.apache.org/jira/browse/NETBEANS-236]:
> Incorrect brace spacing in try-with-resources
> * [NETBEANS-1396|https://issues.apache.org/jira/browse/NETBEANS-1396]: Maven:
> Downloaded javadoc / sources not attached to artifact with classifier
> * [NETBEANS-2197|https://issues.apache.org/jira/browse/NETBEANS-2197]:
> Missing code completion and Javadocs in maven projects with classifier
> * [NETBEANS-2290|https://issues.apache.org/jira/browse/NETBEANS-2290]:
> nb-javac 1.71 fails to parse JavaFX Sources
> The two issues concerning Maven projects will be fixed by the following pull
> request (a work in progress):
> * [apache/netbeans#1548|https://github.com/apache/netbeans/pull/1548]:
> (NETBEANS-1396) Missing code completion and Javadocs in maven projects with
> classifier
> I created the following issues for the new problems described here:
> * [NETBEANS-3297|https://issues.apache.org/jira/browse/NETBEANS-3297]:
> "Attach Javadoc" really means "Attach Sources"
> * [NETBEANS-3298|https://issues.apache.org/jira/browse/NETBEANS-3298]:
> Invalid Javadoc root javafx-sdk-13/doc/javafx.base
> * [NETBEANS-3299|https://issues.apache.org/jira/browse/NETBEANS-3299]: Adding
> Javadoc and Sources to Global Library fails
> * [NETBEANS-3300|https://issues.apache.org/jira/browse/NETBEANS-3300]:
> nb-javac 2.0 fails to parse JavaFX Sources
> * [NETBEANS-3301|https://issues.apache.org/jira/browse/NETBEANS-3301]:
> Modular Ant project fails to run without nb-javac
> * [NETBEANS-3302|https://issues.apache.org/jira/browse/NETBEANS-3302]:
> Non-modular Gradle project fails to recognize Javadoc
> * [NETBEANS-3303|https://issues.apache.org/jira/browse/NETBEANS-3303]:
> Modular Gradle project fails to recognize Javadoc and Sources
> There are also related issues for the JavaFX Javadoc and sample NetBeans
> projects on GitHub:
> * [openjfx/javadoc#6|https://github.com/openjfx/javadoc/issues/6]:
[jira] [Commented] (NETBEANS-3296) Attaching JavaFX Javadoc and Sources
[
https://issues.apache.org/jira/browse/NETBEANS-3296?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16968842#comment-16968842
]
John Neffenger commented on NETBEANS-3296:
--
[~lkishalmi], if there is some extra set-up required to put the Sources and
Javadoc JAR files in the Gradle cache with the correct names, is that something
the [JavaFX Gradle Plug-in|https://github.com/openjfx/javafx-gradle-plugin]
could (or should) be doing?
> Attaching JavaFX Javadoc and Sources
>
>
> Key: NETBEANS-3296
> URL: https://issues.apache.org/jira/browse/NETBEANS-3296
> Project: NetBeans
> Issue Type: Bug
>Affects Versions: 11.2
> Environment: OpenJDK 13.0.1 on Ubuntu 16.04.6 LTS
>Reporter: John Neffenger
>Priority: Major
> Attachments: ant-JAVAFX13-classpath.png, ant-JAVAFX13-javadoc.png,
> ant-JAVAFX13-sources.png, ant-JavaFX13-classpath.png,
> ant-JavaFXMODS13-classpath.png, ant-cannot-use-elements-1.png,
> ant-cannot-use-elements-2.png, ant-command-run.png,
> ant-compile-classpath.png, ant-compile-modulepath.png,
> ant-completion-fails.png, ant-completion-works-1.png,
> ant-completion-works-2.png, ant-edit-jar-reference.png,
> ant-install-nb-javac.png, ant-invalid-javadoc-root.png,
> ant-javadoc-fails.png, ant-source-fails-1.png, ant-source-fails-2.png,
> ant-source-works-1.png, ant-source-works-2.png, ant-try-with-resources.png,
> gradle-completion-fails.png, gradle-completion-works.png,
> gradle-distribution.png, gradle-javadoc-fails.png, gradle-source-works.png,
> java-javadoc-works.png, java-platform-javadoc.png,
> maven-completion-fails.png, maven-dependencies.png, maven-source-fails.png
>
>
> h1. {anchor:attaching-javafx-javadoc-and-sources}Attaching JavaFX Javadoc and
> Sources
> I have been unable to attach the JavaFX Javadoc and Sources to their modular
> JAR files without encountering errors in their use by NetBeans. Attaching the
> Sources allows you to navigate directly to the JavaFX source code of a field
> or method. Attaching the Javadoc allows you to open an external Web browser
> directly to the appropriate page of the documentation. These features are two
> of the main reasons I use an integrated development environment.
> There are several issues encountered in this task, making it easy to lose
> sight of the bigger picture. This is my attempt to provide that more general
> context and gather all the related issues into one place.
> h2. {anchor:issues}Issues
> Some of the problems related to using the JavaFX Javadoc and Sources have
> already been reported:
> * [NETBEANS-236|https://issues.apache.org/jira/browse/NETBEANS-236]:
> Incorrect brace spacing in try-with-resources
> * [NETBEANS-1396|https://issues.apache.org/jira/browse/NETBEANS-1396]: Maven:
> Downloaded javadoc / sources not attached to artifact with classifier
> * [NETBEANS-2197|https://issues.apache.org/jira/browse/NETBEANS-2197]:
> Missing code completion and Javadocs in maven projects with classifier
> * [NETBEANS-2290|https://issues.apache.org/jira/browse/NETBEANS-2290]:
> nb-javac 1.71 fails to parse JavaFX Sources
> The two issues concerning Maven projects will be fixed by the following pull
> request (a work in progress):
> * [apache/netbeans#1548|https://github.com/apache/netbeans/pull/1548]:
> (NETBEANS-1396) Missing code completion and Javadocs in maven projects with
> classifier
> I created the following issues for the new problems described here:
> * [NETBEANS-3297|https://issues.apache.org/jira/browse/NETBEANS-3297]:
> "Attach Javadoc" really means "Attach Sources"
> * [NETBEANS-3298|https://issues.apache.org/jira/browse/NETBEANS-3298]:
> Invalid Javadoc root javafx-sdk-13/doc/javafx.base
> * [NETBEANS-3299|https://issues.apache.org/jira/browse/NETBEANS-3299]: Adding
> Javadoc and Sources to Global Library fails
> * [NETBEANS-3300|https://issues.apache.org/jira/browse/NETBEANS-3300]:
> nb-javac 2.0 fails to parse JavaFX Sources
> * [NETBEANS-3301|https://issues.apache.org/jira/browse/NETBEANS-3301]:
> Modular Ant project fails to run without nb-javac
> * [NETBEANS-3302|https://issues.apache.org/jira/browse/NETBEANS-3302]:
> Non-modular Gradle project fails to recognize Javadoc
> * [NETBEANS-3303|https://issues.apache.org/jira/browse/NETBEANS-3303]:
> Modular Gradle project fails to recognize Javadoc and Sources
> There are also related issues for the JavaFX Javadoc and sample NetBeans
> projects on GitHub:
> * [openjfx/javadoc#6|https://github.com/openjfx/javadoc/issues/6]: Attached
> Javadoc does not follow Maven convention
> * [openjfx/samples#39|https://github.com/openjfx/samples/issues/39]:
> IllegalStateException running NetBeans Modular Maven project
> Each issue is listed again at the point where it's encountered below.
> h2. {anchor:projects}Projects
> I use the six
[jira] [Commented] (NETBEANS-3296) Attaching JavaFX Javadoc and Sources
[
https://issues.apache.org/jira/browse/NETBEANS-3296?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16968836#comment-16968836
]
John Neffenger commented on NETBEANS-3296:
--
Thank you for looking into it, Laszlo. The packaging of the JavaFX artifacts is
the result of discussions in 2018 for finding a way to provide
platform-specific Java and native code in the runtime modules while keeping
that configuration separate from the module dependencies, application code, and
build files. The consensus was that this is the best approach until there's a
more standard way, such as a public JMOD format for artifacts.
Perhaps the best overview is the following message:
* 2019-02-10 [How are library developers supposed to specify JavaFX
dependencies (on JFX/JDK >=
11)?|https://mail.openjdk.java.net/pipermail/openjfx-dev/2019-February/023111.html]
For earlier JavaFX discussions, see the following messages:
* 2018-09-26 [State of maven
artifacts|https://mail.openjdk.java.net/pipermail/openjfx-dev/2018-September/022551.html]
* 2018-06-24 [maven
artifacts|https://mail.openjdk.java.net/pipermail/openjfx-dev/2018-June/022056.html]
The issue was also discussed on the _panama-dev_ mailing list, which mentions
other libraries with the same problem:
* 2018-04-23 [Fwd: JMOD, native libraries and the packaging of
JavaFX|https://mail.openjdk.java.net/pipermail/panama-dev/2018-April/001541.html]
* 2018-04-24 [Fwd: JMOD, native libraries and the packaging of
JavaFX|https://mail.openjdk.java.net/pipermail/panama-dev/2018-April/001543.html]
"JARs that contain native libraries, along with hacky custom code to extract
and load them, are actually quite common," says that first message on
_panama-dev_, so this strange packaging may be with us for a while.
> Attaching JavaFX Javadoc and Sources
>
>
> Key: NETBEANS-3296
> URL: https://issues.apache.org/jira/browse/NETBEANS-3296
> Project: NetBeans
> Issue Type: Bug
>Affects Versions: 11.2
> Environment: OpenJDK 13.0.1 on Ubuntu 16.04.6 LTS
>Reporter: John Neffenger
>Priority: Major
> Attachments: ant-JAVAFX13-classpath.png, ant-JAVAFX13-javadoc.png,
> ant-JAVAFX13-sources.png, ant-JavaFX13-classpath.png,
> ant-JavaFXMODS13-classpath.png, ant-cannot-use-elements-1.png,
> ant-cannot-use-elements-2.png, ant-command-run.png,
> ant-compile-classpath.png, ant-compile-modulepath.png,
> ant-completion-fails.png, ant-completion-works-1.png,
> ant-completion-works-2.png, ant-edit-jar-reference.png,
> ant-install-nb-javac.png, ant-invalid-javadoc-root.png,
> ant-javadoc-fails.png, ant-source-fails-1.png, ant-source-fails-2.png,
> ant-source-works-1.png, ant-source-works-2.png, ant-try-with-resources.png,
> gradle-completion-fails.png, gradle-completion-works.png,
> gradle-distribution.png, gradle-javadoc-fails.png, gradle-source-works.png,
> java-javadoc-works.png, java-platform-javadoc.png,
> maven-completion-fails.png, maven-dependencies.png, maven-source-fails.png
>
>
> h1. {anchor:attaching-javafx-javadoc-and-sources}Attaching JavaFX Javadoc and
> Sources
> I have been unable to attach the JavaFX Javadoc and Sources to their modular
> JAR files without encountering errors in their use by NetBeans. Attaching the
> Sources allows you to navigate directly to the JavaFX source code of a field
> or method. Attaching the Javadoc allows you to open an external Web browser
> directly to the appropriate page of the documentation. These features are two
> of the main reasons I use an integrated development environment.
> There are several issues encountered in this task, making it easy to lose
> sight of the bigger picture. This is my attempt to provide that more general
> context and gather all the related issues into one place.
> h2. {anchor:issues}Issues
> Some of the problems related to using the JavaFX Javadoc and Sources have
> already been reported:
> * [NETBEANS-236|https://issues.apache.org/jira/browse/NETBEANS-236]:
> Incorrect brace spacing in try-with-resources
> * [NETBEANS-1396|https://issues.apache.org/jira/browse/NETBEANS-1396]: Maven:
> Downloaded javadoc / sources not attached to artifact with classifier
> * [NETBEANS-2197|https://issues.apache.org/jira/browse/NETBEANS-2197]:
> Missing code completion and Javadocs in maven projects with classifier
> * [NETBEANS-2290|https://issues.apache.org/jira/browse/NETBEANS-2290]:
> nb-javac 1.71 fails to parse JavaFX Sources
> The two issues concerning Maven projects will be fixed by the following pull
> request (a work in progress):
> * [apache/netbeans#1548|https://github.com/apache/netbeans/pull/1548]:
> (NETBEANS-1396) Missing code completion and Javadocs in maven projects with
> classifier
> I created the following issues for the new problems described here:
> *
[jira] [Commented] (NETBEANS-3296) Attaching JavaFX Javadoc and Sources
[
https://issues.apache.org/jira/browse/NETBEANS-3296?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16968799#comment-16968799
]
Laszlo Kishalmi commented on NETBEANS-3296:
---
Well, probably the main reason behind all of this is how Java FX is packaged.
They package their classes into the platform specific jars. like
javafx-graphics.jar is empty the classes are in javafx-graphics-linux.jar(on
linux) so our binary to source and binary to javadoc queries are trying to
find javadocs and sources for the javafx-graphics-linux.jar and of course there
is none.
[~jgneff] can we know the reason behind this behavior?
On the Maven side it is not that difficult to have modify the heuristics to
find the correct Javadoc or sources. On Gradle it stores every artifact in
their unique folder. So we ask Gradle where is the docs/sources of a given
module. Right now Gradle does not know that the linux jar is a part of a
module, it is just added to the classpath by the javafx Gradle plugin so the
binaries and the source/javadoc become unrelated.
Maybe that changes with Gralde 6.x, I have not tested that yet..
IMHO only the platform dependent code shall be in the platform jar and the
platform jar shall be added to the runtime classpath. Maybe modular java is the
reason for this, still strange...
> Attaching JavaFX Javadoc and Sources
>
>
> Key: NETBEANS-3296
> URL: https://issues.apache.org/jira/browse/NETBEANS-3296
> Project: NetBeans
> Issue Type: Bug
>Affects Versions: 11.2
> Environment: OpenJDK 13.0.1 on Ubuntu 16.04.6 LTS
>Reporter: John Neffenger
>Priority: Major
> Attachments: ant-JAVAFX13-classpath.png, ant-JAVAFX13-javadoc.png,
> ant-JAVAFX13-sources.png, ant-JavaFX13-classpath.png,
> ant-JavaFXMODS13-classpath.png, ant-cannot-use-elements-1.png,
> ant-cannot-use-elements-2.png, ant-command-run.png,
> ant-compile-classpath.png, ant-compile-modulepath.png,
> ant-completion-fails.png, ant-completion-works-1.png,
> ant-completion-works-2.png, ant-edit-jar-reference.png,
> ant-install-nb-javac.png, ant-invalid-javadoc-root.png,
> ant-javadoc-fails.png, ant-source-fails-1.png, ant-source-fails-2.png,
> ant-source-works-1.png, ant-source-works-2.png, ant-try-with-resources.png,
> gradle-completion-fails.png, gradle-completion-works.png,
> gradle-distribution.png, gradle-javadoc-fails.png, gradle-source-works.png,
> java-javadoc-works.png, java-platform-javadoc.png,
> maven-completion-fails.png, maven-dependencies.png, maven-source-fails.png
>
>
> h1. {anchor:attaching-javafx-javadoc-and-sources}Attaching JavaFX Javadoc and
> Sources
> I have been unable to attach the JavaFX Javadoc and Sources to their modular
> JAR files without encountering errors in their use by NetBeans. Attaching the
> Sources allows you to navigate directly to the JavaFX source code of a field
> or method. Attaching the Javadoc allows you to open an external Web browser
> directly to the appropriate page of the documentation. These features are two
> of the main reasons I use an integrated development environment.
> There are several issues encountered in this task, making it easy to lose
> sight of the bigger picture. This is my attempt to provide that more general
> context and gather all the related issues into one place.
> h2. {anchor:issues}Issues
> Some of the problems related to using the JavaFX Javadoc and Sources have
> already been reported:
> * [NETBEANS-236|https://issues.apache.org/jira/browse/NETBEANS-236]:
> Incorrect brace spacing in try-with-resources
> * [NETBEANS-1396|https://issues.apache.org/jira/browse/NETBEANS-1396]: Maven:
> Downloaded javadoc / sources not attached to artifact with classifier
> * [NETBEANS-2197|https://issues.apache.org/jira/browse/NETBEANS-2197]:
> Missing code completion and Javadocs in maven projects with classifier
> * [NETBEANS-2290|https://issues.apache.org/jira/browse/NETBEANS-2290]:
> nb-javac 1.71 fails to parse JavaFX Sources
> The two issues concerning Maven projects will be fixed by the following pull
> request (a work in progress):
> * [apache/netbeans#1548|https://github.com/apache/netbeans/pull/1548]:
> (NETBEANS-1396) Missing code completion and Javadocs in maven projects with
> classifier
> I created the following issues for the new problems described here:
> * [NETBEANS-3297|https://issues.apache.org/jira/browse/NETBEANS-3297]:
> "Attach Javadoc" really means "Attach Sources"
> * [NETBEANS-3298|https://issues.apache.org/jira/browse/NETBEANS-3298]:
> Invalid Javadoc root javafx-sdk-13/doc/javafx.base
> * [NETBEANS-3299|https://issues.apache.org/jira/browse/NETBEANS-3299]: Adding
> Javadoc and Sources to Global Library fails
> * [NETBEANS-3300|https://issues.apache.org/jira/browse/NETBEANS-3300]:
> nb-javac 2.0 fails to parse JavaFX
[jira] [Commented] (NETBEANS-3296) Attaching JavaFX Javadoc and Sources
[
https://issues.apache.org/jira/browse/NETBEANS-3296?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16960421#comment-16960421
]
Geertjan Wielenga commented on NETBEANS-3296:
-
Thanks for this great research. Would be excellent if you'd start a thread on
the Apache NetBeans dev mailing list just to draw people's attention to what
you have here.
> Attaching JavaFX Javadoc and Sources
>
>
> Key: NETBEANS-3296
> URL: https://issues.apache.org/jira/browse/NETBEANS-3296
> Project: NetBeans
> Issue Type: Bug
>Affects Versions: 11.2
> Environment: OpenJDK 13.0.1 on Ubuntu 16.04.6 LTS
>Reporter: John Neffenger
>Priority: Major
> Attachments: ant-JAVAFX13-classpath.png, ant-JAVAFX13-javadoc.png,
> ant-JAVAFX13-sources.png, ant-JavaFX13-classpath.png,
> ant-JavaFXMODS13-classpath.png, ant-cannot-use-elements-1.png,
> ant-cannot-use-elements-2.png, ant-command-run.png,
> ant-compile-classpath.png, ant-compile-modulepath.png,
> ant-completion-fails.png, ant-completion-works-1.png,
> ant-completion-works-2.png, ant-edit-jar-reference.png,
> ant-install-nb-javac.png, ant-invalid-javadoc-root.png,
> ant-javadoc-fails.png, ant-source-fails-1.png, ant-source-fails-2.png,
> ant-source-works-1.png, ant-source-works-2.png, ant-try-with-resources.png,
> gradle-completion-fails.png, gradle-completion-works.png,
> gradle-distribution.png, gradle-javadoc-fails.png, gradle-source-works.png,
> java-javadoc-works.png, java-platform-javadoc.png,
> maven-completion-fails.png, maven-dependencies.png, maven-source-fails.png
>
>
> h1. {anchor:attaching-javafx-javadoc-and-sources}Attaching JavaFX Javadoc and
> Sources
> I have been unable to attach the JavaFX Javadoc and Sources to their modular
> JAR files without encountering errors in their use by NetBeans. Attaching the
> Sources allows you to navigate directly to the JavaFX source code of a field
> or method. Attaching the Javadoc allows you to open an external Web browser
> directly to the appropriate page of the documentation. These features are two
> of the main reasons I use an integrated development environment.
> There are several issues encountered in this task, making it easy to lose
> sight of the bigger picture. This is my attempt to provide that more general
> context and gather all the related issues into one place.
> h2. {anchor:issues}Issues
> Some of the problems related to using the JavaFX Javadoc and Sources have
> already been reported:
> * [NETBEANS-236|https://issues.apache.org/jira/browse/NETBEANS-236]:
> Incorrect brace spacing in try-with-resources
> * [NETBEANS-1396|https://issues.apache.org/jira/browse/NETBEANS-1396]: Maven:
> Downloaded javadoc / sources not attached to artifact with classifier
> * [NETBEANS-2197|https://issues.apache.org/jira/browse/NETBEANS-2197]:
> Missing code completion and Javadocs in maven projects with classifier
> * [NETBEANS-2290|https://issues.apache.org/jira/browse/NETBEANS-2290]:
> nb-javac 1.71 fails to parse JavaFX Sources
> The two issues concerning Maven projects will be fixed by the following pull
> request (a work in progress):
> * [apache/netbeans#1548|https://github.com/apache/netbeans/pull/1548]:
> (NETBEANS-1396) Missing code completion and Javadocs in maven projects with
> classifier
> I created the following issues for the new problems described here:
> * [NETBEANS-3297|https://issues.apache.org/jira/browse/NETBEANS-3297]:
> "Attach Javadoc" really means "Attach Sources"
> * [NETBEANS-3298|https://issues.apache.org/jira/browse/NETBEANS-3298]:
> Invalid Javadoc root javafx-sdk-13/doc/javafx.base
> * [NETBEANS-3299|https://issues.apache.org/jira/browse/NETBEANS-3299]: Adding
> Javadoc and Sources to Global Library fails
> * [NETBEANS-3300|https://issues.apache.org/jira/browse/NETBEANS-3300]:
> nb-javac 2.0 fails to parse JavaFX Sources
> * [NETBEANS-3301|https://issues.apache.org/jira/browse/NETBEANS-3301]:
> Modular Ant project fails to run without nb-javac
> * [NETBEANS-3302|https://issues.apache.org/jira/browse/NETBEANS-3302]:
> Non-modular Gradle project fails to recognize Javadoc
> * [NETBEANS-3303|https://issues.apache.org/jira/browse/NETBEANS-3303]:
> Modular Gradle project fails to recognize Javadoc and Sources
> There are also related issues for the JavaFX Javadoc and sample NetBeans
> projects on GitHub:
> * [openjfx/javadoc#6|https://github.com/openjfx/javadoc/issues/6]: Attached
> Javadoc does not follow Maven convention
> * [openjfx/samples#39|https://github.com/openjfx/samples/issues/39]:
> IllegalStateException running NetBeans Modular Maven project
> Each issue is listed again at the point where it's encountered below.
> h2. {anchor:projects}Projects
> I use the six sample NetBeans projects described in [Getting Started with
> JavaFX
