Как мне создать распространяемый jar-файл для javadocs?

Question

Я создал API, который я выпускаю как файл JAR. Это частная собственность, поэтому мне пришлось удалить из нее исходные файлы.

В настоящее время я включаю отдельную папку / doc, которая содержит выходные данные мастера экспорта в javadoc Eclipse. Неплохо, но я бы хотел сделать еще один шаг вперед.

Я хотел бы распространять Javadocs в виде файла JAR, который можно легко перенести в будущий проект, который включает файл JAR для моего API. Я знаю, что видел, как это делалось несколько раз с другими дистрибутивами, которые я использовал, но мне не повезло в поисках.

Конечная цель - предоставить будущим разработчикам легкий доступ к комментариям и тому подобному.

Спасибо!

Answer 1

Кажется, достаточно упаковать папку doc, содержащую документацию, сгенерированную в eclipse, в виде jar- файла. Затем, если вы хотите использовать этот jar в качестве javadocs фактического jar, содержащего скомпилированные файлы.class, вы назначаете javadoc jar с "Javadoc in archive" в Eclipse и задаете путь в архиве как doc. Похоже, Eclipse ищет записи index.html и package-list в папке doc.

Также использование maven-javadoc-plugin может быть простым способом сделать это. Смотрите ссылку ниже:

http://www.avajava.com/tutorials/lessons/how-do-i-generate-and-deploy-a-javadoc-jar-file-for-my-project.html

Answer 2

Если ваша конечная цель состоит в том, чтобы будущие разработчики могли просматривать ваши инструкции javadoc, когда они используют ваши классы или методы, в Eclipse вы можете иметь возможность экспортировать исходные файлы java при экспорте библиотеки jar, как показано на рисунке ниже.:

Это также позволяет разработчикам входить и просматривать ваши коды во время отладки.