Любой способ вставить Javadoc в банку - PullRequest
6 голосов
/ 05 мая 2011

Есть ли способ встроить javadoc (папку / doc, созданную JavaDoc Ant Task) в мою библиотеку jar, которая содержит мои файлы .class?

Я бы предпочел не отправлять исходный код и хотел бы, чтобы пользователииметь возможность видеть комментарии javadoc в eclipse, не переходя на вкладку Referenced Libraries и добавляя zip-файл JavaDoc в мою стороннюю библиотеку.

Ответы [ 2 ]

3 голосов
/ 05 мая 2011

Конечно, вы можете поместить javadoc в ваш двоичный JAR-файл ... но действительно ли это имеет смысл?

Чтобы прочитать javadocs, пользователь должен будет распаковать HTML-файлы из JAR-файла.файл в файловую систему Android, а затем укажите браузеру Android на файл index.html (или любой другой).Но лучшая модель использования файла JAR для запуска вашего кода - НЕ распаковывать его.И если вы не ожидаете, что ваши пользователи попытаются просмотреть javadoc на своих телефонах (!?!) ... тогда добавление javadocs в файл JAR - это «мертвый вес».

Это делает намного большесмысл распределять дерево javadoc в отдельном файле zip или tar.

Наконец, если вы ожидаете, что пользователи будут разрабатывать код на основе API в вашем продукте, им будет намного легче, если вы предоставите им исходникикод.Вы получите лучшее удовлетворение клиента, меньше запросов в службу поддержки, чтобы помочь им отладить свой код, и меньше необоснованных жалоб о том, что ваш код не работает.

1 голос
/ 05 мая 2011

Конечно, вы можете обновить файл JAR таким образом.

jar uf <your_jar> doc/<your doc file>

...