Как мне создать 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 и устанавливаете путь в архиве как документ .Похоже, что Eclipse ищет index.html и package-list записей в папке doc.

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

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, как показано вИзображение ниже:

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