Как распространять Javadoc для библиотеки? - PullRequest
Новая
       26

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

19 голосов
/ 07 октября 2010

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

  1. Поместите его в тот же .jar с библиотекой
  2. Поместите его в другой .jar
  3. Как-то иначе?

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

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

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

Ответы [ 3 ]

19 голосов
/ 07 октября 2010

Я бы включил библиотеку .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
3 голосов
/ 07 октября 2010

Обычная практика - хранить JavaDocs в отдельном архиве.или даже чаще, в каталоге под названием «документы».вам не нужно раздувать архив вашей библиотеки файлами html и js.

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

Update
Согласно комментарию Нанды ниже, я проверил то же самое, и он прав.В моем проекте я фактически подключил Javadoc из папки 'doc' к архиву, чтобы иметь возможность просматривать их при наведении курсора.

1 голос
/ 06 марта 2015

Другой способ: для меня это был лучший выбор: (добавив build.xml. Я протестировал его в IDE NetBeans 7.0 и 7.2.1) (нашел его в Автоматическое создание jar-файлов источника и документа в 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.

...