如何将项目的Java文档发布到github？

Question

I want to release a project on Github. It works and I can retrieve it as dependency via Gradle. But the JavaDoc is missing.

Message:

Note: This element neither has attached source nor attached Javadoc and hence no Javadoc could be found.

Do i need to build a JAR? Or is there any way to add my JavaDoc to the Project, so JavaDoc is availiable when it is build with gradle?

Answer 1

Do not release JavaDoc to (a) Github (repository), because JavaDoc is derivation products from Java source code.

Let's thinking, when you change comment in JavaDocs, your JavaDocs Github repository also need changing. It is redundancy.

Let 's see few well-known Java projects on Github, such as, https://github.com/spring-projects/spring-boot , they don't put any JavaDoc (HTML files) in a GitHub repository.

Task generate JavaDocs by Gradle: https://docs.gradle.org/current/dsl/org.gradle.api.tasks.javadoc.Javadoc.html

Answer 2

You could use the docs/ folder or the gh-pages branch in order to publish your generated JavaDoc on GitHub.

Example: ebourg.github.io/jsign/apidocs/ from github.com/ebourg/jsign/tree/gh-pages .

The alternative is to publish your deliverables (jars and javadoc.jar) to a binary referentials ( Central Maven or Bintray ) and let a third party service exposes the Javadoc for you.
See " www.javadoc.io "