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

Question

情况如下： 客户希望拥有公共API的文档。我们确实记录了特定的方法并使用@PublicAPI自定义注释进行了注释（以防止这些函数混淆）。

现在我们只想为这些方法生成JavaDocs。我们正在使用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"
}

Answer 2

我多年来一直在使用ExcludeDocklet，效果很好。只需在任何类，成员，字段或包上使用@exclude javadoc标记，它将从生成的javadoc中排除。