Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Missing Javadoc in gradle dependency #25

Closed
MPeti1 opened this issue Nov 2, 2018 · 1 comment
Closed

Missing Javadoc in gradle dependency #25

MPeti1 opened this issue Nov 2, 2018 · 1 comment

Comments

@MPeti1
Copy link

MPeti1 commented Nov 2, 2018

You've documented the code, but the method which compiles and publishes it to Jitpack removes the documentation, and when Gradle downloads the dependency the Javadoc is gone.
It's possible to locally attach the HTML Javadoc to the library, but if I do that it still loads slowly every time I try to open a method's doc

kep

It seems Jake Wharton's Timber for example serves the Javadoc as it should, but I also notice that if I open Timber class the IDE does not show it's decompiled. Maybe the key is to serve the dependency as a source jar, and not as a compiled code jar. As far as I know closed source projects use the latter, but since libsu is open source you could serve the source jar.

Could you take a look at this, please?

@topjohnwu
Copy link
Owner

The Javadoc is already available here: https://topjohnwu.github.io/libsu
Currently I have no plan to change the way of distributing the library, I use JitPack which works out-of-box with Github.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants