[
https://issues.apache.org/jira/browse/NETBEANS-3297?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
John Neffenger updated NETBEANS-3297:
-------------------------------------
Description:
In the examples below, I'm using the JavaFX sample project for NetBeans defined
in the [Non-Modular
Ant|https://github.com/openjfx/samples/tree/master/IDE/NetBeans/Non-Modular/Java]
directory of the [openjfx/samples|https://github.com/openjfx/samples]
repository.
You may need to restart NetBeans after making changes to the items on the
project's Compile Classpath for those changes to be recognized.
First, add just the individual JAR files to the project's Compile Classpath
without adding their Javadoc and Sources.
!classpath-lib.png!
Open the _Main.java_ file, select the method {{show()}}, and see that the
Javadoc is not found, as expected.
!javadoc-lib.png!
Next, add just the Javadoc to each JAR file.
!classpath-lib-doc.png!
The toolbar button (second from right) now allows you to show the documentation
in an external Web browser and opens directly to the correct method. The
Javadoc window shows the method signature, but fails to show the documentation
for the method. NetBeans does not use the Javadoc to display the documentation
after all; it uses the Sources.
!javadoc-lib-doc.png!
So add the Sources to each JAR file, along with the Javadoc.
!classpath-lib-doc-src.png!
Now we see the full documentation, and both toolbar buttons are enabled to show
the documentation in an external Web browser and to open the source in the
editor.
!javadoc-lib-doc-src.png!
Next, remove the Javadoc, leaving just the Sources attached.
!classpath-lib-src.png!
Now the full documentation is still available. The only difference is that the
toolbar button to show the documentation in an external Web browser is disabled.
!javadoc-lib-src.png!
If we select a method with no actual Javadoc comments, such as
{{setTitle(String)}}, we are prompted to attach the Javadoc even though doing
so won't help at all.
!javadoc-lib-src-setTitle.png!
was:More details to follow. Until then, please see the description in the
parent issue.
> "Attach Javadoc" really means "Attach Sources"
> ----------------------------------------------
>
> Key: NETBEANS-3297
> URL: https://issues.apache.org/jira/browse/NETBEANS-3297
> Project: NetBeans
> Issue Type: Sub-task
> Affects Versions: 11.2
> Environment: OpenJDK 13.0.1 on Ubuntu 16.04.6 LTS
> Reporter: John Neffenger
> Priority: Minor
> Attachments: classpath-lib-doc-src.png, classpath-lib-doc.png,
> classpath-lib-src.png, classpath-lib.png, javadoc-lib-doc-src.png,
> javadoc-lib-doc.png, javadoc-lib-src-setTitle.png, javadoc-lib-src.png,
> javadoc-lib.png
>
>
> In the examples below, I'm using the JavaFX sample project for NetBeans
> defined in the [Non-Modular
> Ant|https://github.com/openjfx/samples/tree/master/IDE/NetBeans/Non-Modular/Java]
> directory of the [openjfx/samples|https://github.com/openjfx/samples]
> repository.
> You may need to restart NetBeans after making changes to the items on the
> project's Compile Classpath for those changes to be recognized.
> First, add just the individual JAR files to the project's Compile Classpath
> without adding their Javadoc and Sources.
> !classpath-lib.png!
> Open the _Main.java_ file, select the method {{show()}}, and see that the
> Javadoc is not found, as expected.
> !javadoc-lib.png!
> Next, add just the Javadoc to each JAR file.
> !classpath-lib-doc.png!
> The toolbar button (second from right) now allows you to show the
> documentation in an external Web browser and opens directly to the correct
> method. The Javadoc window shows the method signature, but fails to show the
> documentation for the method. NetBeans does not use the Javadoc to display
> the documentation after all; it uses the Sources.
> !javadoc-lib-doc.png!
> So add the Sources to each JAR file, along with the Javadoc.
> !classpath-lib-doc-src.png!
> Now we see the full documentation, and both toolbar buttons are enabled to
> show the documentation in an external Web browser and to open the source in
> the editor.
> !javadoc-lib-doc-src.png!
> Next, remove the Javadoc, leaving just the Sources attached.
> !classpath-lib-src.png!
> Now the full documentation is still available. The only difference is that
> the toolbar button to show the documentation in an external Web browser is
> disabled.
> !javadoc-lib-src.png!
> If we select a method with no actual Javadoc comments, such as
> {{setTitle(String)}}, we are prompted to attach the Javadoc even though doing
> so won't help at all.
> !javadoc-lib-src-setTitle.png!
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscr...@netbeans.apache.org
For additional commands, e-mail: commits-h...@netbeans.apache.org
For further information about the NetBeans mailing lists, visit:
https://cwiki.apache.org/confluence/display/NETBEANS/Mailing+lists
