如何从 JavaDoc 生成 PDF（包括概述和包摘要）

How to generate a PDF from JavaDoc (including overview and package summaries)

提问by chesterbr

I have written extensive JavaDoc documentation on my application, and added lots of useful info at overview.htmland package.htmlfiles (including links on the former to illustrations in doc-files/). Maven's Javadoc plugin nicely uses the standard javadoc tool to generate the classic JavaDoc frameset, but now I need to generate a PDF with the whole documentation.

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

AurigaDocletgenerates very pretty PDFs, and I was able to make DocFlexwork also. However, both ignore my overview.htmland package.htmlfiles (tried both inside and outside Maven - the PDF will be a once-only thing, since I'd rather have the HTMLs on the long run).

AurigaDoclet生成非常漂亮的 PDF，我也能够使DocFlex工作。但是，两者都忽略了 myoverview.html和package.htmlfiles（在 Maven 内部和外部都尝试过 - PDF 将是一次性的，因为从长远来看我宁愿拥有 HTML）。

Does anyone know how to make AurigaDoclet recoginze my non-Java files? Or, alternatively, another to generate a decent-looking PDF from either the source code or the JavaDoc-generated HTML?

有谁知道如何让 AurigaDoclet 识别我的非 Java 文件？或者，另一种方法是从源代码或 JavaDoc 生成的 HTML 生成看起来不错的 PDF？

采纳答案by chesterbr

Nailed it. After trying all the possible tools to generate straight from the source, I returned to HTMLDOC. It is not JavaDoc-aware, but it is so well built that a few tweaks are enough to make it generate a pretty usable PDF.

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

Here goes a step-by-step description of how I did it:

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

1. Download the software on the releases page;

2. Generate your traditional HTML docs in your preferred way (Ant, Maven, command-line javadoc - your choice);

3. The GUI is nice, but adding all files manually can be cumbersome, so just create a .book file with Document Type set to "Web Page", add one of the HTML files from your generated javadoc's root folder (e.g., overview-summary.html, anyone will do, it's just for reference on step 5). On the Output tab select the PDF format and set a name for it, and add other options to your heart's content (logos, colors, lots of cool stuff here). Save this project (say, myjavadocpdf.book) and close the GUI

4. Generate a list of all HTML files in your javadoc. I did it with Cygwin's find command (my DOS/cmd shell days are long over), but you can do anything you want, as long as you get a file list. In my case a find . | grep html$ | sort -r > files.txtdid the trick; For Windows users, dir /s/b *.html > files.txtshould do the same (but keep in mind you may have to replace \s with /s if they appear like so on the next step).

5. Open the .book file generated on step 3 in your favorite pure text editor (as a programmer you should have strong opinions on that, so will keep my opinions to myself - NOT;-) ) and append the list generated on step 4 to this .book file (it keeps the list of files at the end, making life really easy). Don't forget to fix the relative paths, if needed with a global search/replace (that's why you needed at least one file added on step 3 - to see which file path pattern htmldoc expects);

6. Now you should sort the files in a convenient order. I put my overview first, then package descriptions and each class, then the full index, and everything else at the end. Remember that any file you delete will become an external (hence broken) link, so choose wisely;

7. Save your .book file and re-open it on HTMLDOC. Voila: all files added and sorted. Click on generate. That's it!

1. 在发布页面下载软件；

2. 以您喜欢的方式生成您的传统 HTML 文档（Ant、Maven、命令行 javadoc - 您的选择）；

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

4. 在您的 javadoc 中生成所有 HTML 文件的列表。我是用Cygwin的 find 命令完成的（我的 DOS/cmd shell 时代已经过去了），但是你可以做任何你想做的事情，只要你得到一个文件列表。就我而言， afind . | grep html$ | sort -r > files.txt成功了；对于 Windows 用户，也dir /s/b *.html > files.txt应该这样做（但请记住\，/如果 s 在下一步中看起来像这样，您可能需要将s替换为s ）。

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

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

7. 保存您的 .book 文件并在 HTMLDOC 上重新打开它。瞧：所有文件都被添加和排序。点击生成。就是这样！

You may want to fiddle with images (hint: use HTML width/height, not style/css). In the end, the resulting file is surprisingly good: nice looking and fully navigable for internal and external links. Impressive when you consider that the tool is not Java(Doc) aware at all...

您可能想要摆弄图像（提示：使用 HTML 宽度/高度，而不是样式/css）。最后，生成的文件出奇地好：外观漂亮且完全可导航内部和外部链接。当您认为该工具根本不了解 Java(Doc) 时，这令人印象深刻...

EDIT: software is now free from original author; updated links, thank you @mohammed

编辑：软件现在不受原作者的影响；更新的链接，谢谢@mohammed

回答by MCory

According to the Sun JavaDoc FAQ, there's a couple of options -- mostly free, with one or two commercial offerings as well. Check it out at http://java.sun.com/j2se/javadoc/faq/index.html#print.

根据 Sun JavaDoc 常见问题解答，有几个选项——大部分是免费的，还有一两个商业产品。在http://java.sun.com/j2se/javadoc/faq/index.html#print 上查看。

回答by weberjn

AurigaDoclet fails to process package.html. For a fix see my comment at https://sourceforge.net/projects/aurigadoclet/forums/forum/339169/topic/1572199/index/page/1

AurigaDoclet 无法处理 package.html。有关修复，请参阅我在https://sourceforge.net/projects/aurigadoclet/forums/forum/339169/topic/1572199/index/page/1 上的评论

回答by Pa?lo Ebermann

If this question was bumped anyways, I can use this to link my ltxdocletproject.

如果无论如何都遇到了这个问题，我可以使用它来链接我的ltxdoclet项目。

This creates from the source (by being a JavaDoc plugin) documentation in LaTeX format, which you then can pass through PdfLaTeX to produce a PDF.

这从源代码（通过作为 JavaDoc 插件）以 LaTeX 格式创建文档，然后您可以通过 PdfLaTeX 生成PDF。

Optionally it also can include pretty-printed source code.

可选地，它还可以包含印刷精美的源代码。