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

Published Javadocs are empty #98

Closed
EdricChan03 opened this issue Jun 26, 2023 · 2 comments · Fixed by #103
Closed

Published Javadocs are empty #98

EdricChan03 opened this issue Jun 26, 2023 · 2 comments · Fixed by #103
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@EdricChan03
Copy link
Contributor

It appears that the javadoc.jar file served at the Gradle Plugin Portal is empty when extracted - is this intentional?

@aSemy aSemy added the documentation Improvements or additions to documentation label Jun 26, 2023
@aSemy
Copy link
Contributor

aSemy commented Jun 26, 2023

Dokkatoo doesn't intentionally publish a Javadoc JAR. I guess it's enabled automatically by java-gradle-plugin, and since there are no Java sources it's empty.

A Javadoc JAR (even if it's empty) might be required by the Gradle Plugin Portal? I know that Maven Central requires a Javadoc JAR (again, even if it's empty) (related: #61).

If it were up to me, I wouldn't publish one at all! The sources JAR should be superior to a Javadoc JAR, since the source code is visible within IDEs. If Dokka were more performant (e.g. Kotlin/dokka#1405) then I could be persuaded to generate a Javadoc site for the Javadoc JAR, but at the moment I'd rather not.

Can you explain more about why you are asking? Were you just double checking? Is the Javadoc JAR required for something?

@EdricChan03
Copy link
Contributor Author

Can you explain more about why you are asking? Were you just double checking? Is the Javadoc JAR required for something?

Just curious, unrelated checking when looking into publishing Javadocs for an Android library

@aSemy aSemy added this to the v1.5.1 milestone Jun 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants