Skip to content

Commit e73e5e7

Browse files
sandwwraithsandwwraith
committed
Increase visibility of the json-okio integration module: add it to the Dokka generated website
1 parent 5fb55ff commit e73e5e7

File tree

5 files changed

+581
-7
lines changed

5 files changed

+581
-7
lines changed

‎dokka/moduledoc.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,10 @@ format implementation.
55
# Module kotlinx-serialization-json
66
Stable and ready to use JSON format implementation, `JsonElement` API to operate with JSON trees and JSON-specific serializers.
77

8+
# Module kotlinx-serialization-json-okio
9+
Extensions for kotlinx.serialization.json.Json for integration with the popular [Okio](https://square.github.io/okio/) library.
10+
Currently experimental.
11+
812
# Module kotlinx-serialization-cbor
913
Concise Binary Object Representation (CBOR) format implementation, as per [RFC 7049](https://tools.ietf.org/html/rfc7049).
1014

@@ -42,6 +46,9 @@ HOCON serialization format implementation for converting Kotlin classes from and
4246
JSON serialization format implementation, JSON tree data structures with builders for them,
4347
and JSON-specific serializers.
4448

49+
# Package kotlinx.serialization.json.okio
50+
Extensions for kotlinx.serialization.json.Json for integration with the popular [Okio](https://square.github.io/okio/) library.
51+
4552
# Package kotlinx.serialization.protobuf
4653
Protocol buffers serialization format implementation, mostly compliant to [proto2](https://developers.google.com/protocol-buffers/docs/proto) specification.
4754

‎formats/README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,14 @@ were not included in the core library.
55

66
For convenience, they have same `groupId`, versioning and release cycle as core library.
77

8-
| Format | Artifact id | Platform | Status | Notes |
9-
|------------|------------------------------------|-------------------------|--------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
10-
| JSON | `kotlinx-serialization-json` | all supported platforms | stable |
11-
| HOCON | `kotlinx-serialization-hocon` | JVM only | experimental | Allows deserialization of `Config` object from popular [lightbend/config](https://github.com/lightbend/config) library into Kotlin objects.You can learn about "Human-Optimized Config Object Notation" or HOCON from library's [readme](https://github.com/lightbend/config#using-hocon-the-json-superset). |
12-
| ProtoBuf | `kotlinx-serialization-protobuf` | all supported platforms | experimental |
13-
| CBOR | `kotlinx-serialization-cbor` | all supported platforms | experimental |
14-
| Properties | `kotlinx-serialization-properties` | all supported platforms | experimental | Allows converting arbitrary hierarchy of Kotlin classes to a flat key-value structure à la Java Properties. |
8+
| Format | Artifact id | Platform | Status | Notes |
9+
|------------|------------------------------------|---------------------------------|--------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
10+
| JSON | `kotlinx-serialization-json` | all supported platforms | stable | |
11+
| JSON-Okio | `kotlinx-serialization-json-okio` | all supported by Okio platforms | experimental | Extensions on Json for integration with [Okio](https://square.github.io/okio/) library. |
12+
| HOCON | `kotlinx-serialization-hocon` | JVM only | experimental | Allows deserialization of `Config` object from popular [lightbend/config](https://github.com/lightbend/config) library into Kotlin objects.You can learn about "Human-Optimized Config Object Notation" or HOCON from library's [readme](https://github.com/lightbend/config#using-hocon-the-json-superset). |
13+
| ProtoBuf | `kotlinx-serialization-protobuf` | all supported platforms | experimental | |
14+
| CBOR | `kotlinx-serialization-cbor` | all supported platforms | experimental | |
15+
| Properties | `kotlinx-serialization-properties` | all supported platforms | experimental | Allows converting arbitrary hierarchy of Kotlin classes to a flat key-value structure à la Java Properties. |
1516

1617
## Other community-supported formats
1718

‎formats/json-okio/build.gradle.kts

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
* Copyright 2017-2022 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
33
*/
44
import Java9Modularity.configureJava9ModuleInfo
5+
import org.jetbrains.dokka.gradle.*
6+
import java.net.*
57

68
plugins {
79
kotlin("multiplatform")
@@ -29,3 +31,16 @@ kotlin {
2931
}
3032

3133
project.configureJava9ModuleInfo()
34+
35+
tasks.named<DokkaTaskPartial>("dokkaHtmlPartial") {
36+
dokkaSourceSets {
37+
configureEach {
38+
externalDocumentationLink {
39+
url.set(URL("https://square.github.io/okio/3.x/okio/"))
40+
packageListUrl.set(
41+
file("dokka/okio.package.list").toURI().toURL()
42+
)
43+
}
44+
}
45+
}
46+
}

0 commit comments

Comments
 (0)