如何为图书馆分发Javadoc？

Question

我正在写一个自定义库.它构建成.jar存档.我完全能够生成javadoc,但我不知道应该如何分发它？

1. 将它放在与库相同的.jar中
2. 把它放在一个不同的.jar中
3. 还有其他方法吗？

以及如何将javadoc包含在另一个使用我的lib的项目中？

1. 如果我把它放在同一个.jar中,我应该在清单中写一些东西吗？
2. 如果它在一个单独的.jar中,是否足够包含在项目中？

我使用的是NetBeans 9.1.

Answer 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

您可以在mylib-1.0.1-javadoc.jar(或zip)中添加压缩的javadoc,而不是存档中扩展的javadoc/sub目录,这两个选项都很常见.

mylib-1.0.1/
           ??? mylib-1.0.1-javadoc.jar
           ??? mylib-1.0.1.jar
           ??? README