Как выпустить Java-документ проекта на github?

Question

Я хочу выпустить проект на Github. Это работает, и я могу получить его как зависимость через Gradle. Но JavaDoc отсутствует.

Сообщение:

Примечание. Этот элемент не имеет ни подключенного источника, ни присоединенного Javadoc, и, следовательно, Javadoc не может быть найден.

Мне нужно построить JAR? Или есть какой-нибудь способ добавить мой JavaDoc в проект, чтобы JavaDoc был доступен, когда он собран с gradle?

Answer 1

Не выпускайте JavaDoc для (a) Github (репозиторий), потому что JavaDoc - это продукты деривации из исходного кода Java.

Давайте подумаем, когда вы изменяете комментарий в JavaDocs, ваш репозиторий JavaDocs Github также нуждается в изменении. Это избыточность.

Давайте рассмотрим несколько известных Java-проектов на Github, таких как https://github.com/spring-projects/spring-boot, они не помещают JavaDoc (HTML-файлы) в репозиторий GitHub.

Задача генерации JavaDocs Gradle: https://docs.gradle.org/current/dsl/org.gradle.api.tasks.javadoc.Javadoc.html

Answer 2

Вы можете использовать папку docs/ или gh-pages ветку , чтобы опубликовать сгенерированный JavaDoc на GitHub.

Пример: ebourg.github.io /jsign / apidocs / из github.com/ebourg/jsign/tree/gh-pages.

Альтернативой является публикация ваших результатов (jars и javadoc.jar) в двоичные ссылки ( Central Maven * 1015)* или Bintray ), и пусть сторонняя служба предоставляет вам Javadoc.
См. "www.javadoc.io"