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

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

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

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

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

Ответы

Ответ 1

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

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

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

Ответ 2

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

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