使用 Ant 仅为接口生成 Javadoc?

发布于 2024-08-31 08:23:38 字数 213 浏览 7 评论 0原文

我正在使用 Apache Ant 为我的程序生成 Javadoc,该程序有许多项目(或模块)。但是,我只想为接口生成 Javadoc,并且我不知道如何检查文件是否是 Ant 中的类或接口。有人建议我应该使用 并指定要排除或包含的文件列表。但是,我的程序中有数百个文件,并且指定要排除的类文件列表是不可能的。

请问有人有什么想法吗?

I am using Apache Ant to generate Javadoc for my program which has many projects (or modules). However, I want to generate Javadoc for Interfaces only, and I do not know how to check if a file is a class or interface in Ant. Someone suggested me that I should use <fileset> and specify a list of files to exclude or include. However, there are hundreds of files in my program and specifying a list of class files to exclude is impossible.

Does anyone have some ideas, please?

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。

评论(2

慕巷 2024-09-07 08:23:38

我不相信这是可能的,除非您编写自己的自定义 ant 任务(实际上这并不难)并在您的 Ant 脚本中引用它。

另一种(更丑陋的)方法是生成完整的 java-doc 并删除非接口文件。例如,可以通过查看 allclasses-frame.html 来识别这些:

<A HREF="javax/swing/text/ComponentView.html" title="class in javax.swing.text" target="classFrame">ComponentView</A>
<A HREF="java/awt/Composite.html" title="interface in java.awt" target="classFrame"><I>Composite</I></A>

其中类型(在 title=... 中)和文件(href=...)都可用。

I don't believe this is possible unless you write your own custom ant-task, (which wouldn't be that hard actually) and reference that in your Ant-script.

Another, (much uglier) way would be to generate the complete java-doc and remove non-interface files. These could for instance be identified by looking at the allclasses-frame.html:

<A HREF="javax/swing/text/ComponentView.html" title="class in javax.swing.text" target="classFrame">ComponentView</A>
<A HREF="java/awt/Composite.html" title="interface in java.awt" target="classFrame"><I>Composite</I></A>

where you have both the type (in the title=...) and file (href=...) available.

宛菡 2024-09-07 08:23:38

您是否考虑过编写自己的 doclet?不要试图让 ant 来完成这项工作,而是创建一个知道如何丢弃每个非接口的 doclet。那么,在ant中使用javadoc任务就很简单了。

希望有帮助。

Have you considered writing your own doclet? Instead of trying to get ant to do the work, create a doclet that knows how to discard every non-interface. Then, using the javadoc task in ant is simple.

Hope that helps.

~没有更多了~
我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
原文