search

kelemen / netbeans-gradle-project

This project is a NetBeans plugin able to open Gradle based Java projects. The implementation is based on Geertjan Wielenga's plugin.
172 stars 57 forks source link

Show javadoc ? #359

Open ptitpix opened 6 years ago

ptitpix commented 6 years ago

Hello,

When I begin with a new library, I like to see all the javadoc so I do "Show JAVADOC" on a class ( ALT F1 ). It doesn't work with gradle dependencies even with the idea module loaded and downloadJavadoc=true. Any ideas ?

Thanx'

kelemen commented 6 years ago

You have to click "Download sources" on the dependencies node. Usually for most open source libraries (Maven Central even enforces this), you don't need the javadocs because the sources are enough (NB will render the doc better from them).

ptitpix commented 6 years ago

Thank you for your quick response but it doesn't work. I see javadoc within the autocompletion popin but I can't browse the javadoc outside netbeans by clicking the "show javadoc" in the contextual menu of a class in the source panel: netbeans writes "can't perform the show javadoc here" in the status bar. I guess it's another Netbeans action. I'm running netbeans 8.2. I can make a short video if you want. Thank you again for your quick response and have a good sunday.

ptitpix commented 6 years ago

Hello again,

I did some tests this afternoon and I figured out that "show javadoc" can't work if sources are present because the GradleCacheJavadocForBinaryQuery prefers sources over javadoc in any situation. I cleared my gradle cache, modified my build.gradle not to download sources and now everything works as expected until some other gradle project sharing the same dependencies is configured to download sources again.

I've seen a todo in the GradleCacheJavadocForBinaryQuery.java:49 about adding a parameter to choose between source or javadoc to show javadoc. Do you plan to do something about it ? If not I'll see to clone your project, do a modification and send you a pull request for approval.

Thank you.

kelemen commented 6 years ago

I didn't yet do it because there was no request for it. A PR would be welcome but if it is needed, I would do it anyway though unsure when exactly because I have a couple of other things to attend to at the moment.