如何从 JavaDoc 生成 PDF(包括概述和包摘要)

2022-09-01 19:13:06

我已经在我的应用程序上编写了大量的JavaDoc文档,并在 和 文件中添加了许多有用的信息(包括前者指向 插图的链接)。Maven的Javadoc插件很好地使用标准的javadoc工具来生成经典的JavaDoc框架集,但现在我需要生成一个包含整个文档的PDF。overview.htmlpackage.htmldoc-files/

AurigaDoclet生成非常漂亮的PDF,我也能够使DocFlex工作。但是,两者都忽略了我的和文件(在Maven内部和外部都尝试过 - PDF将是一个只有一次的东西,因为从长远来看,我宁愿使用TML)。overview.htmlpackage.html

有谁知道如何让AurigaDoclet重新识别我的非Java文件?或者,或者,另一个从源代码或JavaDoc生成的HTML生成一个外观不错的PDF?


答案 1

搞定了。在尝试了所有可能的工具直接从源代码生成之后,我回到了HTMLDOC。它不是JavaDoc感知的,但它构建得非常好,一些调整就足以使它生成一个非常可用的PDF。

以下是我是如何做到的分步描述:

  1. 版本页面上下载软件;

  2. 以您喜欢的方式生成传统的HTML文档(Ant,Maven,命令行javadoc - 您的选择);

  3. GUI很好,但是手动添加所有文件可能很麻烦,因此只需创建一个文档类型设置为“网页”的.book文件,从生成的javadoc根文件夹中添加一个HTML文件(例如,overview-summary.html,任何人都会这样做,这只是步骤5的参考)。在“输出”选项卡上,选择PDF格式并为其设置名称,然后在您的心脏内容中添加其他选项(徽标,颜色,此处有很多很酷的东西)。保存此项目(例如 )并关闭 GUImyjavadocpdf.book

  4. 生成 javadoc 中所有 HTML 文件的列表。我用Cygwin的find命令做到了这一点(我的DOS / cmd shell时代早已结束),但是只要你得到一个文件列表,你就可以做任何你想做的事情。在我的情况下,a做了伎俩;对于Windows用户,应该做同样的事情(但请记住,如果它们在下一步中看起来像这样,则可能必须将s替换为s)。find . | grep html$ | sort -r > files.txtdir /s/b *.html > files.txt\/

  5. 在你最喜欢的纯文本编辑器中打开步骤3生成的.book文件(作为程序员,你应该对此有强烈的意见,所以会把我的意见留给我自己 - 不是;-))并将步骤4生成的列表附加到这个.book文件(它保留了文件列表在最后,使生活变得非常容易)。如果需要,不要忘记修复相对路径,并进行全局搜索/替换(这就是为什么您需要在步骤3中添加至少一个文件的原因 - 以查看htmldoc期望的文件路径模式);

  6. 现在,您应该以方便的顺序对文件进行排序。我先把我的概述放在第一位,然后是包描述和每个类,然后是完整的索引,最后是其他所有内容。请记住,您删除的任何文件都将成为外部(因此损坏)链接,因此请明智地选择;

  7. 保存 .book 文件,然后在 HTMLDOC 上重新打开它。瞧:所有文件都已添加并排序。点击生成。就是这样!

您可能想要摆弄图像(提示:使用HTML宽度/高度,而不是style / css)。最后,生成的文件出奇地好:好看,完全可以导航内部和外部链接。当您考虑到该工具根本不知道Java(Doc)时,令人印象深刻...

编辑:软件现在是免费的原作者;更新链接,谢谢@mohammed


答案 2

根据 Sun JavaDoc FAQ,有几个选项 - 大部分是免费的,还有一两个商业产品。在 http://java.sun.com/j2se/javadoc/faq/index.html#print 查看。


推荐