微信公众号搜"智元新知"关注
微信扫一扫可直接关注哦!

如何将文档字符串添加到 build.gradle.kts 中的 android maven-publish .aar 文件?

如何解决如何将文档字符串添加到 build.gradle.kts 中的 android maven-publish .aar 文件?

我有一个带有标准 Java 库的项目,它创建了几个 .jar 文件一个是文档集,另一个是源集。现在我已经使用 maven-publish 插件成功创建了一个 android-library,但是当我将 .aar 文件添加到另一个项目时,它们既不包含源代码也不包含注释作为 .jar 版本做了,所以我没有在 IDE 内部获得帮助,也没有研究方法的实现。

我需要向我的 build.gradle.kts 添加什么才能在我作为文件本地发布的 .aar 的调试版本中包含文档字符串和源代码?该 Android 开发人员页面链接的 gradle 文档根本没有提及任何有关文档字符串或来源的信息。

import org.jetbrains.kotlin.config.KotlinCompilerVersion

plugins {
    id("com.android.library")
    kotlin("android")
    `maven-publish`
}

group = "com.wavelt.libs"
version = "1.0.0"


android {
    compileSdkVersion(30)
    buildToolsversion = "30.0.2"
    defaultConfig {
        minSdkVersion(16)
        targetSdkVersion(30)
        versionCode = 1
        versionName = "1.0.0"
        testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
        consumerProguardFiles("consumer-rules.pro")
    }
    buildTypes {
        getByName("release") {
            isMinifyEnabled = false
            proguardFiles(
                getDefaultProguardFile("proguard-android-optimize.txt"),"proguard-rules.pro"
            )
        }
    }
    compileOptions {
        sourceCompatibility = JavaVersion.VERSION_1_8
        targetCompatibility = JavaVersion.VERSION_1_8
    }
    kotlinoptions {
        jvmTarget = "1.8"
        freeCompilerArgs = listof("-Xinline-classes")
    }
}

dependencies {
    implementation(kotlin("stdlib-jdk7",KotlinCompilerVersion.VERSION))
    implementation("androidx.core:core-ktx:1.3.2")
    implementation("androidx.appcompat:appcompat:1.2.0")
    implementation("com.google.android.material:material:1.3.0")
    testImplementation("junit:junit:4.13.2")
    androidTestImplementation("androidx.test.ext:junit:1.1.2")
    androidTestImplementation("androidx.test.espresso:espresso-core:3.3.0")
    androidTestImplementation("com.android.support.test:runner:1.0.2")
    androidTestImplementation("com.android.support.test:rules:1.0.2")
}

// https://developer.android.com/studio/build/maven-publish-plugin
afterEvaluate {
    publishing {
        repositories {
            maven {
                // https://docs.gradle.org/current/userguide/publishing_maven.html#publishing_maven:repositories
                url = uri("$buildDir/repository")
            }
        }
        publications {
            create<MavenPublication>("debug") {
                // Applies the component for the release build variant.
                from(components["debug"])
                artifactId = "wavelt-android-debug"
                artifact("androidJavadocsJar") // Doesn't seem to work
            }
            create<MavenPublication>("release") {
                // Applies the component for the release build variant.
                from(components["release"])
                artifactId = "wavelt-android"
            }
        }
    }
}

解决方法

虽然我读过其他开发人员能够将 javadoc 塞入 --------------------------------------- -992.123 -45678.000 0.000 0.000 321.000 0.000 (6 rows affected) 文件,但从 Android Studio 等 IDE 内部获取文档和源代码检查根本没有明确必要。事实上,看看典型的 java 库的工作方式,它会创建如下文件:

  • .aar
  • foo-ver.jar
  • foo-ver-sources.jar

与 Android 库的唯一区别是拥有这些文件:

  • foo-ver-javadoc.jar
  • foo-ver.aar
  • foo-ver-sources.jar

这意味着源代码和 javadoc jars 仍然可以沿着 foo-ver-javadoc.jar 复制,IDE 将加载它们。话虽如此,发布示例代码仅创建 .aar 文件,查看 other questions like this one 我能够修改脚本以创建 .aar 以及另外两个 .aar 包:

.jar

通过这些修改,import org.jetbrains.kotlin.config.KotlinCompilerVersion plugins { id("com.android.library") kotlin("android") `maven-publish` id("org.jetbrains.dokka") version "0.9.17" } group = "com.wavelt.libs" version = "1.0.0" android { compileSdkVersion(30) buildToolsVersion = "30.0.2" defaultConfig { minSdkVersion(16) targetSdkVersion(30) versionCode = 1 versionName = "1.0.0" testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner" consumerProguardFiles("consumer-rules.pro") } buildTypes { getByName("release") { isMinifyEnabled = false proguardFiles( getDefaultProguardFile("proguard-android-optimize.txt"),"proguard-rules.pro" ) } } compileOptions { sourceCompatibility = JavaVersion.VERSION_1_8 targetCompatibility = JavaVersion.VERSION_1_8 } kotlinOptions { jvmTarget = "1.8" freeCompilerArgs = listOf("-Xinline-classes") } } dependencies { //implementation(fileTree(mapOf("dir" to "libs","include" to listOf("*.jar")))) implementation(kotlin("stdlib-jdk7",KotlinCompilerVersion.VERSION)) implementation("androidx.core:core-ktx:1.3.2") implementation("androidx.appcompat:appcompat:1.2.0") implementation("com.google.android.material:material:1.3.0") testImplementation("junit:junit:4.13.2") androidTestImplementation("androidx.test.ext:junit:1.1.2") androidTestImplementation("androidx.test.espresso:espresso-core:3.3.0") androidTestImplementation("com.android.support.test:runner:1.0.2") androidTestImplementation("com.android.support.test:rules:1.0.2") } tasks.dokka { outputFormat = "html" outputDirectory = "$buildDir/javadoc" moduleName = rootProject.name } val dokkaJar by tasks.creating(Jar::class) { group = JavaBasePlugin.DOCUMENTATION_GROUP description = "Assembles Kotlin docs with Dokka" archiveClassifier.set("javadoc") from(tasks.dokka) dependsOn(tasks.dokka) } val sourcesJar by tasks.creating(Jar::class) { group = JavaBasePlugin.DOCUMENTATION_GROUP description = "Assembles sources JAR" archiveClassifier.set("sources") from(android.sourceSets.getByName("main").java.srcDirs) } artifacts { archives(sourcesJar) archives(dokkaJar) } // https://developer.android.com/studio/build/maven-publish-plugin afterEvaluate { publishing { repositories { maven { // https://docs.gradle.org/current/userguide/publishing_maven.html#publishing_maven:repositories url = uri("$buildDir/repository") } } publications { create<MavenPublication>("debug") { // Applies the component for the release build variant. from(components["debug"]) artifactId = "wavelt-android-debug" artifact(sourcesJar) artifact(dokkaJar) } create<MavenPublication>("release") { // Applies the component for the release build variant. from(components["release"]) artifactId = "wavelt-android" } } } } 任务将生成所有文件,尽管其中一个文件具有 ./gradlew publish,但当它们一起复制到另一个项目时,它们的工作方式与 .aar 相同。

版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。