使用Gradle生成Android库Javadoc时如何排除内部Java类？

问题根源 #

直接用exclude移除内部类源文件会导致Javadoc解析依赖类（比如Foo.java）时找不到被排除的内部类——源文件被移除后，编译路径中缺失了这些类的定义，进而触发lint报错。而错误禁用全局lint虽然能让任务执行，但无法真正移除内部类的文档。

正确解决方案 #

核心思路：保留所有源文件以保证依赖解析正常，仅过滤掉不需要生成文档的内部类/包，具体配置如下：

方案1：通过exclude参数指定要排除的包/类 #

task javadoc(type: Javadoc) {
    // 保留所有源文件，确保依赖能被正常解析
    source = android.sourceSets.main.java.sourceFiles
    
    // 添加Android bootclasspath，避免找不到Android SDK相关类
    classpath += project.files(android.getBootClasspath().join(File.pathSeparator))
    classpath += configurations.implementationClasspath // 根据Gradle版本调整，如compileClasspath
    
    // 排除整个internal包的文档生成
    options.addStringOption('exclude', 'com.example.customlib.internal')
    
    // 若需排除单个类，替换为：
    // options.addStringOption('exclude', 'com.example.customlib.internal.Utils')
    
    // 禁用Xdoclint检查，避免内部类引用导致的报错
    options.addStringOption('Xdoclint:none', null)
    
    // 仅生成public级别类/方法的文档，进一步过滤内部实现
    options.memberLevel = JavadocMemberLevel.PUBLIC
}

方案2：通过过滤器过滤文档文件 #

如果需要更灵活的过滤规则，可使用filter方法：

task javadoc(type: Javadoc) {
    source = android.sourceSets.main.java.sourceFiles
    classpath += project.files(android.getBootClasspath().join(File.pathSeparator))
    classpath += configurations.implementationClasspath
    
    // 过滤掉internal包下的所有类，不生成它们的文档
    options.filter { docFile ->
        !docFile.path.contains('com/example/customlib/internal')
    }
    
    options.addStringOption('Xdoclint:none', null)
    options.memberLevel = JavadocMemberLevel.PUBLIC
}

为什么之前的方法失效？ #

• 直接exclude源文件：会从Javadoc的编译路径中移除该文件，导致其他依赖它的类无法被正常解析，触发"package does not exist"错误。
• 错误禁用lint：Xdoclint:none src/main/java/...的写法不符合Javadoc参数规范，实际是全局禁用了lint，但并未过滤掉要排除的类，所以这些类仍会出现在文档中。

内容的提问来源于stack exchange，提问作者Joan P.S