Как включить (проверенные, не устаревшие) образцы кода в документацию пакета Dokka?
В частности, если у меня есть эта конфигурация в моем build.gradle.kts
:
withType<DokkaTask> {
outputFormat = "html"
outputDirectory = "$buildDir/documentation"
includes = listOf("packageDocumentation.md")
samples = listOf("$rootDir/src/test/kotlin/some/project/TheSamples.kt")
}
А затем какой-нибудь тестовый код:
package some.project
import org.junit.jupiter.api.Test
class TheSamples {
@Test
fun helloWorldSample() {
println("hello, world")
}
}
, а также файл разметки документации пакета:
# Package some.project
This is the documentation for some package.
@sample some.project.TheSamples#helloWorldSample
, как мне включить println(...)
-часть в документацию? Поддерживается ли это вообще в текущей версии Dokka?
Обмен #
на .
или замена @sample
на @includeFunction
ничего не сделали.
Более того: