使用 doclava 生成 Javadoc 时出现 Nullable 注释错误

Question

我正在尝试在 Android Studio 中使用 Doclava 为 Android 库生成 Javadoc。源代码在某些时候使用了 "Nullable" 标记，这会在生成 javadoc 时导致崩溃：

In doclet class com.google.doclava.Doclava, method start has thrown an exception java.lang.reflect.InvocationTargetException com.sun.tools.javac.code.Symbol$CompletionFailure: class file for javax.annotation.Nullable not found

我能以某种方式克服这个问题吗？

Answer 1

我必须在 Javadoc 的类路径中包含 findbugs:jsr305 库。

所以，在我的 Gradle 配置中，我添加了：

dependencies {

    // For Doclava JavaDoc
    jaxDoclet("com.google.doclava:doclava:1.0.6")
    classpaths files('build/intermediates/classes/release')
    classpaths 'com.google.code.findbugs:jsr305:3.0.1'
}

task javadoc(type: Javadoc) {
     //.... the rest of the configuration
     options {
         classpath += configurations.classpaths.files.asType(List)
         //.... the rest of the configuration
      } 
}

Answer 2

对于此异常，请在此处查看：https://code.google.com/p/android/issues/detail?id=1261

只需在命令末尾添加-XDignore.symbol.file，就可以消除这个异常。

使用 doclava 生成 Javadoc 时出现 Nullable 注释错误

Error with Nullable annotation when generating Javadoc using doclava

javadoc

nullable

android-studio