Невозможно увидеть комментарии KDoc в библиотеке Android после публикации через JitPackAndroid

Форум для тех, кто программирует под Android
Ответить
Anonymous
 Невозможно увидеть комментарии KDoc в библиотеке Android после публикации через JitPack

Сообщение Anonymous »

В настоящее время я разрабатываю библиотеку Android на Kotlin и столкнулся с проблемой: комментарии к моим методам [Изображение 1] не отображаются в потребляющем проекте [Изображение 2] после публикации библиотеки с помощью JitPack. p>
[Определение функции в моей библиотеке]

Код: Выделить всё

/**
* 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)
Настройка библиотеки Gradle

Код: Выделить всё

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
Ответить

Быстрый ответ

Изменение регистра текста: 
Смайлики
:) :( :oops: :roll: :wink: :muza: :clever: :sorry: :angel: :read: *x)
Ещё смайлики…
   
К этому ответу прикреплено по крайней мере одно вложение.

Если вы не хотите добавлять вложения, оставьте поля пустыми.

Максимально разрешённый размер вложения: 15 МБ.

Вернуться в «Android»