代码之家 › 专栏 › 技术社区 › chesterbr

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

maven-pdf-plugin javadoc pdf java

21

chesterbr · 技术社区 · 16 年前

我已经在我的应用程序上编写了大量的JavaDoc文档,并在 overview.html 和 package.html doc-files/

AurigaDoclet DocFlex overview.html package.html 文件(在Maven内部和外部都尝试过——PDF将是唯一的东西,因为从长远来看,我宁愿使用HTMLs)。

有人知道如何让AurigaDoclet重新编码我的非Java文件吗?或者,另一种方法是从源代码或JavaDoc生成的HTML生成外观良好的PDF?

4 回复 | 直到 6 年前

1

23

chesterbr 7 年前

搞定了。在尝试所有可能的工具直接从源代码生成后,我返回到 HTMLDOC . 它不支持JavaDoc,但它构建得非常好,只需稍作调整就足以生成一个非常有用的PDF。

下面是我如何做的一步一步的描述:

将软件下载到 releases page ;
以您喜欢的方式生成传统的HTML文档(Ant、Maven、命令行javadoc—您的选择);
GUI很好,但是手动添加所有文件可能会很麻烦,所以只需创建一个.book文件,将文档类型设置为“网页”,从生成的javadoc的根文件夹中添加一个HTML文件(例如,overview-summary.HTML,任何人都可以,仅供第5步参考)。在“输出”选项卡上,选择PDF格式并为其设置名称,然后将其他选项添加到您的心脏内容中(徽标、颜色,这里有很多很酷的东西)。保存这个项目(比如, myjavadocpdf.book
生成javadoc中所有HTML文件的列表。我是和你一起做的 Cygwin 的find命令(我的DOS/cmd shell时代已经过去了),但是只要有一个文件列表,您就可以做任何您想做的事情。就我而言,a find . | grep html$ | sort -r > files.txt 他成功了; 对于Windows用户, dir /s/b *.html > files.txt \ 和 /
在你最喜欢的纯文本编辑器中打开步骤3中生成的.book文件(作为程序员,你应该对此有强烈的意见,所以请保留我的意见)- NOT ;-) ) 并将步骤4中生成的列表附加到此.book文件(它将文件列表保留在末尾,使生活变得非常简单)。如果需要全局搜索/替换,请不要忘记修复相对路径(这就是为什么您需要在步骤3中至少添加一个文件-以查看htmldoc期望的文件路径模式);
保存.book文件并在HTMLDOC上重新打开它。瞧,所有文件都被添加和排序了。单击generate。就这样!

您可能想要摆弄图像(提示:使用HTML宽度/高度,而不是样式/css)。最后,生成的文件出人意料地好:外观漂亮,内部和外部链接完全可导航。当你认为工具不是java(DOC)的时候,你会印象深刻…

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

2

MCory 16 年前

http://java.sun.com/j2se/javadoc/faq/index.html#print .

3

2

weberjn 15 年前

有关修复方法,请参阅我的评论 https://sourceforge.net/projects/aurigadoclet/forums/forum/339169/topic/1572199/index/page/1

4

2

PaÅlo Ebermann 15 年前

如果这个问题受到了质疑,我可以用它来链接我的 ltxdoclet 项目

这将从源代码(通过JavaDoc插件)创建LaTeX格式的文档,然后您可以通过PdfLaTeX生成PDF。