Как распределить Javadoc для библиотеки?

Я пишу пользовательскую библиотеку. Он встроен в архив .jar. Я полностью могу генерировать javadoc, но я не знаю, как его распространять?

  • Поместите его в тот же .jar с помощью библиотеки
  • Поместите его в другой .jar
  • Другой способ?

А как включить javadoc в другой проект, который использует мою lib?

  • Если бы я поставил его в том же .jar, должен ли я написать что-то в манифесте?
  • Если он в отдельном .jar, включает его в проект достаточно?

Я использую NetBeans 9.1.

Ответы

Ответ 1

Я бы включил библиотеку .jar и документацию и другие вещи, например README, файл лицензии и т.д. в одном архиве (zip или tar.gz)

mylib-1.0.1.tar.gz, который содержит:

mylib-1.0.1/
           ├── javadoc
           │   └── index.html  (and all other javadoc files under here)
           ├── mylib-1.0.1.jar
           └── README

Вместо расширенного javadoc/sub каталога в архиве вы можете добавить сжатый javadoc в mylib-1.0.1-javadoc.jar(или zip), оба варианта являются общими.

mylib-1.0.1/
           ├── mylib-1.0.1-javadoc.jar
           ├── mylib-1.0.1.jar
           └── README

Ответ 2

Это обычная практика сохранения JavaDocs в отдельном архиве. или даже чаще, в каталоге под названием "docs". вы не нуждаетесь в раздувании своего библиотечного архива с файлами html и js.

И почему вы хотите включить сгенерированные JavaDocs [html + js] в свой проект? До тех пор, пока комментарии исходного кода JavaDoc на месте, кто-то, использующий вашу библиотеку, сможет их увидеть, просто нависая над w/mouse в любой из современных IDE

Обновление
Согласно комментарию nanda ниже, я проверил то же самое, и он прав. В моем проекте я фактически привязал Javadocs из папки "doc" к архиву, чтобы иметь возможность просматривать их при наведении курсора мыши.

Ответ 3

Другой способ: Для меня это был лучший выбор: (добавление к build.xml. Я протестировал его на IDE 7.0 и 7.2.1 в NetBeans) (нашел его на Автоматически генерируя банки источника и документа в Netbeans)

<target name="-post-jar" description="bundle sources and javadoc in a jar" depends="javadoc">
<jar compress="${jar.compress}" basedir="${src.dir}" jarfile="${dist.dir}/${application.title}-sources.jar"/>
<jar compress="${jar.compress}" basedir="${test.src.dir}" jarfile="${dist.dir}/${application.title}-test.jar"/>
<jar compress="${jar.compress}" basedir="${dist.javadoc.dir}" jarfile="${dist.dir}/${application.title}-javadoc.jar"/>

Это создаст четыре банки, одну для прикладной программы, одну для источников, одну для тестов и одну для javadoc.