summaryrefslogtreecommitdiff
path: root/gradle/dokka.gradle
diff options
context:
space:
mode:
Diffstat (limited to 'gradle/dokka.gradle')
-rw-r--r--gradle/dokka.gradle23
1 files changed, 23 insertions, 0 deletions
diff --git a/gradle/dokka.gradle b/gradle/dokka.gradle
index 157ab82e..5a208f2b 100644
--- a/gradle/dokka.gradle
+++ b/gradle/dokka.gradle
@@ -7,10 +7,12 @@ apply plugin: 'org.jetbrains.dokka'
def documentedSubprojects = ["kotlinx-serialization-core",
"kotlinx-serialization-json",
+ "kotlinx-serialization-json-okio",
"kotlinx-serialization-cbor",
"kotlinx-serialization-properties",
"kotlinx-serialization-hocon",
"kotlinx-serialization-protobuf"]
+
subprojects {
if (!(name in documentedSubprojects)) return
apply plugin: 'org.jetbrains.dokka'
@@ -20,6 +22,8 @@ subprojects {
tasks.named('dokkaHtmlPartial') {
outputDirectory = file("build/dokka")
+ pluginsMapConfiguration.set(["org.jetbrains.dokka.base.DokkaBase": """{ "templatesDir": "${rootProject.projectDir.toString().replace('\\', '/')}/dokka-templates" }"""])
+
dokkaSourceSets {
configureEach {
includes.from(rootProject.file('dokka/moduledoc.md').path)
@@ -36,6 +40,13 @@ subprojects {
suppress.set(true)
}
+ // Internal JSON API
+ perPackageOption {
+ matchingRegex.set("kotlinx\\.serialization.json.internal(\$|\\.).*")
+ suppress.set(true)
+ reportUndocumented.set(false)
+ }
+
// Workaround for typealias
perPackageOption {
matchingRegex.set("kotlinx\\.serialization.protobuf.internal(\$|\\.).*")
@@ -56,6 +67,18 @@ subprojects {
reportUndocumented.set(false)
skipDeprecated.set(true)
}
+
+ // JS/Native implementation of JVM-only `org.intellij.lang.annotations.Language` class to add syntax support by IDE.
+ perPackageOption {
+ matchingRegex.set("org\\.intellij\\.lang\\.annotations(\$|\\.).*")
+ suppress.set(true)
+ }
+
+ sourceLink {
+ localDirectory.set(rootDir)
+ remoteUrl.set(new URL("https://github.com/Kotlin/kotlinx.serialization/tree/master"))
+ remoteLineSuffix.set("#L")
+ }
}
}
}