仅适用于package-info.java的javadoc

时间:2009-07-16 15:21:34

标签: java maven-2 javadoc package

我有一种情况,我想在没有类的项目中执行javadoc。它只有一个包的package-info.java。执行javadoc时,会出现以下错误:

An error has occurred in JavaDocs report generation:Exit code: 1 - javadoc: error - No public or protected classes found to document.

有没有办法强迫它只处理package-info.java(除了显而易见的hacky解决方案:创建一个虚拟类,编写一个package.html复制脚本等)?

我正在执行javadoc作为maven构建的一部分,因此maven-javadoc-plugin正在执行实际的javadoc命令。

1 个答案:

答案 0 :(得分:9)

没有办法让JavaDoc在空包上运行。有一个非常古老的bug被标记为“已关闭,无法修复”。

在那个bug中,解决方法几乎是你提到的显而易见的hacky,创建一个默认范围的空类。除非你强制它与-package或-private一起使用,否则该类不会包含在javadoc中。

/** hack to generate package javadoc */
class PlaceHolder {}