将多个模块的Javadoc合并到一个集合中 [英] Combine Javadoc for multiple modules into a single collection

问题描述

我有一个由几个模块组成的Java应用程序.我想为所有这些文件一起生成Javadoc:也就是说，从这几个模块中，我想要一个HTML文件集合，其中包含一个index.html，一个allclasses-frame.html等，以及各种HTML文件.超链接应可跨模块使用.

I have a Java application consisting of several modules. I'd like to generate Javadoc for all of them together: that is to say, from these several modules, I'd like a single collection of HTML files with a single index.html, a single allclasses-frame.html etc. and the various hyperlinks should work across modules.

我使用Maven，但不一定要局限于Maven特定的解决方案.这将由cron作业执行，因此也可以使用其他工具.

I use Maven but I'm not necessarily constrained to Maven-specific solutions. This will be performed by a cron job so other tools could also be used.

在这种情况下，自动生成Javadoc的最直接方法是什么?

What is the most straightforward way to auto-generate Javadoc in this case?

推荐答案

如果可以管理它，则只要组合输入源，javadoc就可以生成组合文档.也许有一个更优雅的解决方案.但是，为什么不将所有源复制到组合树中然后运行javadoc?

If you can manage it, javadoc can generate the combined documentation provided that you combine the input sources. Perhaps there is a more elegant solution; but, why not copy all the sources into a combined tree and then run javadoc?

另一种选择是使用-link选项，并使一个站点的文档参考另一站点的文档.请注意，如果选择此选项，则可能还需要查看linkoffline选项，以提高javadoc构建的灵活性(除非您设法在以后的构建中需要以正确的顺序将文档部署到Web服务器之前).

The other option is to use the -link option and have one site's documentation refer to another site's documentation. Note that if you choose this option, you may want to also look at the linkoffline option for flexibility in your javadoc builds (unless you manage to deploy documentation to the web servers in the correct order before it is needed by subsequent builds).

这篇关于将多个模块的Javadoc合并到一个集合中的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！