java - 如何创建仅包含用自定义注释注释的类/方法的 JavaDoc？

Question

情况是这样的:客户想要一份公共(public) API 的文档。我们确实记录了特定的方法，并使用 @PublicAPI 自定义注释对其进行了注释(以防止这些函数被混淆)。

现在我们只想为这些方法生成 JavaDoc。我们正在使用 gradle，我知道我可以过滤源，但这对我们来说还不够——API 经常更改。

有什么想法吗？

Answer 1

您应该使用自定义 Doclet，例如 this one .只需修改 exclude 方法即可。然后，创建自定义 Javadoc 任务:

task generatePublicAPIDocs(type: Javadoc) {
  source = sourceSets.main.allJava
  destinationDir = your/dest/dir
  options.docletpath = your/doclet/path
  options.doclet = "com.yourdoclet.TheDoclet"
}