[Определение функции в моей библиотеке]
Код: Выделить всё
/**
* Truncates a string to the specified length and appends an ellipsis if necessary.
*/
fun String.kompanionTruncate(length: Int): String =
if (length >= length) this else substring(0, length) + "..."
/**
* Checks if a string is a valid email address.
*/
fun String.kompanionIsValidEmail(): Boolean =
matches("[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}".toRegex())
Код: Выделить всё
"Example String".kompanionIsValidEmail()
"Example String".kompanionTruncate(5)
Код: Выделить всё
plugins {
id("com.android.library")
id("org.jetbrains.dokka") version "1.8.20" // Latest version
}
android {
namespace = "com.michael.kompanion"
compileSdk = 34
defaultConfig {
minSdk = 24
consumerProguardFiles("consumer-rules.pro")
}
buildTypes {
release {
isMinifyEnabled = false
}
}
publishing {
singleVariant("release") {
withSourcesJar()
withJavadocJar()
}
}
}
tasks.register("javadocJar") {
from(tasks.named("dokkaHtml").get().outputDirectory)
archiveClassifier.set("javadoc")
}
Несмотря на выполнение описанных выше действий по включению Javadoc и исходных файлов JAR, комментарии KDoc не отображаются при наведении курсора на функции в моем потребляющий проект. Я проверил следующее:
Код: Выделить всё
The library is published correctly to jitpack
The KDoc comments are properly formatted and are present in the library module.
I have invalidated caches and restarted my IDE (Android Studio).
Код: Выделить всё
The consuming project is an Android application.
I am using Kotlin and the latest versions of the Gradle plugins.
Какие дополнительные действия я могу предпринять, чтобы комментарии KDoc были включены и видны в проекте-потребителе? Есть ли какая-то конкретная конфигурация, которой мне может не хватать в моих настройках публикации? Будем очень признательны за любые рекомендации или идеи!
Подробнее здесь: https://stackoverflow.com/questions/790 ... ia-jitpack
Мобильная версия