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

Question

我想在Github上发布一个项目。 它有效，我可以通过Gradle将其检索为依赖项。 但是缺少JavaDoc。

消息：

  

注意：该元素既没有附加源，也没有附加Javadoc，因此找不到Javadoc。

我需要构建一个JAR吗？还是有什么方法可以将我的JavaDoc添加到项目中，因此在使用gradle构建JavaDoc时可用吗？

Answer 1

请勿将JavaDoc发布到（a）Github（存储库），因为JavaDoc是Java源代码的派生产品。

让我们思考一下，当您在JavaDocs中更改注释时，您的JavaDocs Github存储库也需要更改。这是冗余。

让我们在Github上看到一些著名的Java项目，例如https://github.com/spring-projects/spring-boot，它们没有在GitHub存储库中放置任何JavaDoc（HTML文件）。

任务通过Gradle生成JavaDoc：https://docs.gradle.org/current/dsl/org.gradle.api.tasks.javadoc.Javadoc.html

Answer 2

您可以use the docs/ folder or the gh-pages branch以便在GitHub上发布生成的JavaDoc。

示例：ebourg.github.io/jsign/apidocs/中的github.com/ebourg/jsign/tree/gh-pages。

另一种方法是将可交付成果（jar和javadoc.jar）发布到二进制引用（Central Maven或Bintray），然后让第三方服务为您公开Javadoc。
参见“ www.javadoc.io”