Javadoc 排除导致导入错误

Question

我正在为我公司制作的库调整 javadoc。我们希望从并非真正供公众使用的类(主要是内部使用的类)中排除 javadoc。

该项目使用 gradle 作为构建系统，我在 build.gradle 文件中标记了我们要排除的包/类。但是，这会导致错误发生。如果存在指向被排除的类的@link，我希望得到警告或错误，但是当那些被排除的类被简单地导入时它也会抛出错误。有没有办法“包含”类/包，但不为它们导出 javadoc？

编辑:这是相关的 javadoc 任务:

task gendocs(type: Javadoc) {
    options.stylesheetFile = new File("./assets/doc_style.css")
    String v = "${SEMVER}"
    version = v.replace("_", '.')
    title = "SweetBlue ${version} API"
    options.windowTitle = "SweetBlue"
    options.memberLevel = JavadocMemberLevel.PROTECTED
    options.author = true
    options.linksOffline('http://d.android.com/reference', System.getenv("ANDROID_HOME") + '/docs/reference')    
    destinationDir = new File("${BUNDLE_FOLDER}/docs/api")
    source = sourceSets.main.allJava
    classpath += configurations.compile
    exclude "com/idevicesinc/sweetblue/backend"
    exclude "com/idevicesinc/sweetblue/utils/Utils**.java"
    exclude "com/idevicesinc/sweetblue/utils/UpdateLoop.java"
    exclude "com/idevicesinc/sweetblue/utils/Pointer.java"
    exclude "com/idevicesinc/sweetblue/utils/HistoricalDataQuery.java"
}

编辑 2:这是我所说的错误:

SweetBlue/src/com/idevicesinc/sweetblue/BleCharacteristic.java:5: error: cannot find symbol
import com.idevicesinc.sweetblue.utils.Utils;                                      
symbol:   class Utils
location: package com.idevicesinc.sweetblue.utils

编辑 3:

似乎在 gradle javadoc 任务中排除与在命令行中使用 javadoc 时使用 -exclude 不同。我使用 CLI javadoc 生成运行了一个测试，但没有收到使用 Gradle 时出现的未发现错误。

---

我也有posted this on the Gradle forum但在那里没有收到答复。

Answer 1

Javadoc 需要了解导入的类。告诉 javadoc 在哪里可以找到类文件而不是带有类路径的 java 源代码!

我在 XJC 生成的代码中遇到了同样的问题，该代码在 ant 环境中生成了大量的 javadoc 错误。为了从文档中排除它们但仍然满足 javadoc，我只是告诉 javadoc 任务查看 bin 文件夹:

<target name="javadoc" description="create Javadoc documentation">
    <javadoc ...lots of irrelevant attributes skipped...>
        <fileset dir="src">
            <include name="**/*.java"/>
            <exclude name="my/jaxb/generated/source/*.java"/>
        </fileset>
        <classpath>
            <path refid="myclasspath_to_referenced_libraries"/>
            <pathelement location="bin"/>
        </classpath>
    </javadoc>
</target>