如何为javadocs创建可分发的jar?
我创建了一个我作为JAR文件发布的API。 它是专有的,所以我不得不从中删除源文件。
我目前包含一个单独的/ doc文件夹,其中包含Eclipse的export-to-javadoc向导的输出。 不错,但我想更进一步。
我想将javadocs作为jar文件分发,可以很容易地将其放入包含我的API的jar文件的未来项目中。 我知道我已经看过它用我用过的其他发行版多次这样做了,但我没有找到任何运气。
最终目标是允许未来的开发人员轻松访问hover在评论和这种性质的事物上。
谢谢!
似乎将包含eclipse生成文档的doc文件夹打包为jar文件就足够了。 然后,如果要将该jar用作包含已编译.class文件的实际jar的javadoc,则在Eclipse中为javadoc jar分配“Javadoc in archive” ,并将archive中的Path设置为doc 。 Eclipse似乎在doc文件夹中查找index.html和package-list条目。
同样使用maven-javadoc-plugin可能是一种简单的方法。 请参阅以下链接:
如果您的最终目标只是让未来的开发人员能够在使用您的类或方法时查看您的javadoc指令,那么在Eclipse中您可以选择在导出jar库时导出java源文件,如下图所示:
这也允许开发人员在调试时介入并查看代码。