2011-08-19 24 views
15

我创建了一个我作为JAR文件发布的API。它是专有的,所以我不得不剥夺源文件。如何为javadoc创建一个jar分发包?

我目前包含一个单独的/ doc文件夹,其中包含Eclipse的export-to-javadoc向导的输出。不错,但我想更进一步。

我想将javadocs作为jar文件分发,可以很容易地将其放入包含我的API的jar文件的未来项目中。我知道我已经多次用我用过的其他发行版来看过它,但是我没有找到任何运气。

最终目标是让未来的开发人员能够轻松地将鼠标悬停在评论和此类事物上。

谢谢!

+0

至少对于问题的第二部分...以下是有关如何将JavaDocs放入Eclipse中的详细说明http://stackoverflow.com/a/11579339/356895 – JJD

回答

11

看来它已经足以将doc包含eclipse生成文档的文件夹打包为jar文件。然后,如果你想使用的水瓶中包含编译的.class文件的实际罐子的javadoc,分配在Eclipse中的“归档的Javadoc”的Javadoc罐子,并设置归档路径为DOC。看来Eclipse在doc文件夹中查找index.html软件包列表条目。

Setting Javadoc location in Eclipse

另外使用maven-javadoc-plugin可能是一个简单的方法来做到这一点。请参见下面的链接:

http://www.avajava.com/tutorials/lessons/how-do-i-generate-and-deploy-a-javadoc-jar-file-for-my-project.html

+0

感谢您的建议。我实际上偶然发现了javadoc maven插件,尽管我不想将maven引入非maven项目。我将更多地了解插件实际上在做什么,这可能会帮助我理解如何在不使用maven的情况下生成javadoc jar。感谢帮助,我会跟进任何其他调查结果。 – Batman0730

+0

@ Batman0730我编辑了答案。你能按我描述的方式尝试吗? – suat

+1

我认为这清除了我一直以来的误解。你不能将这些javadoc.jar文件放在一个项目中,并且神奇地获得附加到代码的注释。您必须手动将javadocs附加到其库中,即使它们是.jar格式。我之前从未测试过,所以我的假设一直是错误的。 感谢您的帮助。 – Batman0730

0

如果你的最终目标是只是对未来的开发人员能够在他们使用你的类或方法来查看你的javadoc说明,在Eclipse中你可以选择导出的java当您导出的jar库如下图所示的图像源文件:

enter image description here

这也让开发者介入并查看您的代码,同时调试。

相关问题