gRPC-android环境下生成javadoc-Java

此篇文章是介绍Java语言生成文档过程，如果你用的是kotlin语言，请跳转下面的链接查看生成文档。https://www.jianshu.com/p/27f1302a49f0?v=1673238889178

gRPC生成javadoc过程持续让我找了好几天，过程很费劲且有点难记，所以在此记录下来。以备后用。
1.首先proto文件配置的时候最好和主代码的包名一致。

1.png

如红色框里面的就要和你的代码包名一致。后面生成javadoc方便。
2.如下图，红色框里是我的proto文件生成类都拷贝到代码主包下。

2.png

。
蓝色框里的代码是我的主业务代码。
绿色框里的是proto文件。
3.配置gradle
在你的Modul或app的gradle文件下配置

android {
    namespace 'com.vw.gamebasesdk'
    compileSdk 33

    defaultConfig {
     ...
    }

    buildTypes {
      ...
    }

    lintOptions {
        disable 'GoogleAppIndexingWarning', 'HardcodedText', 'InvalidPackage'
        textReport true
        textOutput "stdout"
    }

    compileOptions {
        sourceCompatibility JavaVersion.VERSION_1_8
        targetCompatibility JavaVersion.VERSION_1_8
    }

    tasks.withType(Javadoc) {
        failOnError false
        options.addStringOption('Xdoclint:none', '-quiet')
        options.addStringOption('encoding', 'UTF-8')
        options.addStringOption('charSet', 'UTF-8')
    }
}

task javaDoc(type: Javadoc) {
    delete("javadoc/") //清理旧的 javadoc
    options {
        encoding('UTF-8') //支持中文，避免乱码
        charSet('UTF-8') //支持中文，避免乱码
        memberLevel = JavadocMemberLevel.PUBLIC //保留 public 的方法
        linkSource true
        author false //是否保留作者
        noTree true //是否生成树状结构
        noIndex true
        noNavBar true
    }
    source = android.sourceSets.main.java.srcDirs //生成 javadoc 的源目录
    //模块下的第三方库的类名也能被索引{@link}，应对 javadoc 提示“错误：找不到符号”
    classpath += project.files(android.getBootClasspath().join(File.pathSeparator))
    destinationDir = file("javadoc/") //生成 javadoc 的目标目录
    failOnError false //报错不中断
}

afterEvaluate {
    javaDoc.classpath += files(android.libraryVariants.collect { variant ->
        variant.javaCompileProvider.get().classpath.files
    })
}

4.执行Task
找到你的Gradle窗口，点击下面的Task即可生成

4.png

有不成功的可以留言给我，我们一起学习成长。