java doc

  1. // 打包 javadoc
  2. task javadoc(type: Javadoc) {
  3.     group = 'uploadMaven'
  4.     failOnError  false
  5.     options.encoding = "utf-8"
  6.     source = android.sourceSets.main.java.sourceFiles
  7.     destinationDir file("$rootDir/doc")
  8. }

kotlin doc

kotlin 文件想要生成 doc 文档需要使用 dokka (gradle 插件)

根目录下的 build.gradle 文件里添加如下配置

  1. buildscript {
  2.     ...
  3.     dependencies {
  4.         ...
  5.         classpath 'org.jetbrains.dokka:dokka-gradle-plugin:0.10.1'
  6.     }
  7. }

kotlin 项目的 build.gradle 文件里添加如下配置

  1. apply plugin: 'org.jetbrains.dokka'
  3. dokka {
  4.     // 输出类型
  5.     outputFormat = 'javadoc'
  6.     // 输出目录
  7.     outputDirectory = "$rootDir/doc"
  9.     configuration {
  10.         externalDocumentationLink {
  11.             noJdkLink = true
  12.             noStdlibLink = true
  13.             noAndroidSdkLink = true
  15.             url = new URL("https://developer.android.google.cn/reference/")
  16.             packageListUrl = new URL("https://developer.android.google.cn/reference/package-list")
  17.         }
  18.     }
  19. }

打包 doc

  1. // 打包 java doc 文档
  2. task javadocZip(type: Zip, dependsOn: javadoc) {
  3.     group = 'uploadMaven'
  4.     archiveClassifier = 'doc'
  5.     from "$rootDir/doc"
  6. }
  8. // 打包 kotlin doc 文档
  9. task docZip(type: Zip, dependsOn: dokka) {
  10.     group = 'uploadMaven'
  11.     archiveClassifier = 'doc'
  12.     from "$rootDir/doc"
  13. }

在 Terminal 里运行如下命令即可得到 doc

  1. // 创建 doc
  2. ./gradlew javadoc
  3. ./gradlew dokka
  5. // 打包 doc
  6. ./gradlew javadocZip
  7. ./gradlew docZip

参考地址如下