在没有源的情况下构建JDoc

时间:2014-11-04 13:58:23

标签: java eclipse maven documentation artifactory

我有一个人工服务器(http://www.jfrog.com/open-source/),我用它来部署某些第三方库。我有一个特定的第三方库,它与一个包含所述库的JDocs的doc目录一起提供。

我真的想将doc目录编译到一个jar中,这样我的团队就可以从artifactory中拖下JDocs(以及第三方jar),而不必独立分发doc目录。我用google搜索的所有教程都表明你必须有源文件才能做到这一点......显然,我没有。

我为maven看到的事情表明我需要源/项目。

我尝试过使用javadoc -d .\docs -source .\java\classes\library.jar -subpackage com.foobar,但它很活跃。

我尝试使用Eclipse将JDocs导出为聚合jar,但这要么不可能,要么我错过了一些符文。

1 个答案:

答案 0 :(得分:0)

假设您的第三方javdoc目录结构如下所示

3rd-party-doc/
   +- index.html
   +- index-all.html
   +- ...

您可以使用以下命令

创建一个javadoc jar
jar cvf 3rd-party-javadoc.jar -C 3rd-party-doc/ .

这将生成包含javadoc的3rd-party-javadoc.jar,例如,您可以将其安装到本地maven存储库中。

修改 将生成的javadoc安装到本地maven存储库

mvn install:install-file -Dfile=3rd-party-javadoc.jar -DgroupId=com.example.3rd.party -DartifactId=3rd-party -Dversion=1.2.3 -Dpackaging=jar -Dclassifier=javadoc -DcreateChecksum=true

# -Dfile=3rd-party-javadoc.jar - the javadoc file you have generated
# -DgroupId=com.example.3rd.party - the maven group id of the 3rd party library (same as in repository/.../3rd-party-x.y.z.pom)
# -DartifactId=3rd-party - the maven artifact id of the 3rd party library (same as in repository/.../3rd-party-x.y.z.pom)
# -Dversion=1.2.3 - the 3rd party library version (same as in repository/.../3rd-party-x.y.z.pom)