当前位置: 首页 > 面试题库 >

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

岳阳飙
2023-03-14
问题内容

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

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

有谁知道如何使AurigaDoclet重新识别我的非Java文件?或者,另外一种选择是从源代码还是由JavaDoc生成的HTML生成外观精美的PDF?


问题答案:

搞定了。在尝试了所有可能的工具以直接从源代码生成之后,我返回了HTMLDOC。它不是支持JavaDoc的软件,但是它的构建是如此完善,以至于进行一些调整就足以使其生成漂亮的PDF。

这是我如何做的分步说明:

  1. 在发布页面上下载软件;

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

  3. GUI很好,但是手动添加所有文件可能很麻烦,因此只需创建文档类型设置为“网页”的.book文件,然后从生成的javadoc的根文件夹中添加一个HTML文件即可(例如,概述摘要)。 html,任何人都可以做,仅供参考(第5步)。在“输出”选项卡上,选择PDF格式并为其设置一个名称,然后在您的心脏内容中添加其他选项(徽标,颜色和许多有趣的内容)。保存该项目(例如myjavadocpdf.book),然后关闭GUI

  4. 生成javadoc中所有HTML文件的列表。我是用Cygwin的find命令完成的(我的DOS / cmd shell时代已经过去了),但是只要您得到文件列表,您就可以做任何您想做的事情。就我而言,这find . | grep html$ | sort -r > files.txt是骗人的。对于Windows用户,dir /s/b *.html > files.txt应执行相同的操作(但请记住\/如果在下一步中出现,则可能必须将替换为)。

  5. 打开(作为一个程序员,你应该有对强烈的意见,所以会继续我的意见,我自己-在你喜欢的纯文本编辑器中的步骤3中产生的.book文件不 ;-)),并追加第4步生成此列表.book文件(它将文件列表保留在末尾,使生活变得非常轻松)。如果需要使用全局搜索/替换,请不要忘记修复相对路径(这就是为什么您需要在第3步上至少添加一个文件-以便查看htmldoc期望的文件路径模式);

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

  7. 保存您的.book文件,然后在HTMLDOC上重新打开它。瞧:添加并排序的所有文件。单击生成。而已!

您可能想弄弄图像(提示:使用HTML宽度/高度,而不是样式/
css)。最后,生成的文件非常好:外观漂亮,并且可以完全导航到内部和外部链接。当您认为该工具完全不了解Java(Doc)时,印象深刻…

编辑:软件现在可以从原始作者那里免费获得;更新的链接,谢谢@mohammed



 类似资料:
  • 当node_module库导入索引文件时,webpack为什么不在构建中包含这些库? webpack对我来说仍然是一种黑色的艺术,我还没有完全掌握,所以下面是我试图实现的一个解释。 我正在构建一个测试应用程序,以在AWS Lambda节点服务器上作为无服务器代码运行。目标是通过在服务器上有一个或多个块并且没有node_modules文件夹,使部署包尽可能小。 我正在用TypescriptV3编写文

  • 我希望我的库的javadoc的“概述”页面本质上是整个JAR的用户/API指南。我知道添加一个class to a package允许您编写包级别的javadocs,但是jar级别的呢? 我知道我可以在我的项目的根目录下放一个,但是我喜欢把README看作是库开发人员(也就是维护库的人)的文档。但是JavaDocs是将使用库的人的应用编程接口指南。

  • 问题内容: 我目前正在使用在大多数类型和元素上具有/ 的XML模式。当我从此XML模式生成Java Bean时,这些Bean的Javadoc仅包含一些有关类型/元素的允许内容的通用生成信息。 我想在相关位置查看标记的内容(例如,complextType的标记的内容应显示在代表该complexType的类的Javadoc中)。 有什么办法可以做到这一点? 编辑 :此XML Schema将在具有JAX

  • 我想用pdf摘要签署pdf文件。我使用下面的代码创建了散列, 最后,我需要把这个签名附在我的PDF上。我找到了一个解决方案,从文件摘要创建pkcs7签名,但在链接中使用的算法是SHA256with RSA。我的privatekey是使用EC算法生成的,我需要使用SHA256withECDSA。是否可以使用SHA256withECDSA对哈希进行签名,并使用PDFBox ExternalSignin

  • 本文向大家介绍Oracle中的软件包概述,包括了Oracle中的软件包概述的使用技巧和注意事项,需要的朋友参考一下 包是SQL过程,函数,变量,语句等,它们被分组为一个单元。许多不同的应用程序可以共享程序包的内容,因为它存储在数据库中。 包装件 以下是Oracle中软件包的各个部分- 包装规格 软件包规范包含有关存储在其中的所有过程,函数,变量,常量等的信息。它具有所有组件的声明,但没有代码。 规

  • 问题内容: 我目前正在尝试在运行期间构造设备覆盖的区域。此过程的第一步似乎是构造覆盖区域的多边形。由于图案不是标准形状,因此凸包通过跳到可能的最大覆盖区域来夸大覆盖区域。 我发现有一篇论文似乎涵盖了非凸面船体生成的概念,但是没有讨论如何在高级语言中实现该概念。 http://www.geosensor.net/papers/duckham08.PR.pdf 有没有人看到一个简单的算法来构造一个非凸