From a70bb5243cf148cbce26afacd427ec280c7ef5b8 Mon Sep 17 00:00:00 2001 From: Ugljesa Jovanovic Date: Tue, 17 Nov 2020 23:27:49 +0100 Subject: [PATCH] Bump dokka, update dokka calls, add test md package and module docs --- buildSrc/src/main/kotlin/Deps.kt | 4 ++-- multiplatform-crypto-api/build.gradle.kts | 7 +++--- .../build.gradle.kts | 7 +++--- .../build.gradle.kts | 22 ++++++++++++++----- .../com.ionspin.kotlin.crypto/CryptoModule.md | 3 +++ .../com.ionspin.kotlin.crypto/aead/Aead.md | 4 ++++ multiplatform-crypto/build.gradle.kts | 7 +++--- .../kotlin/crypto/sample/DataPackage.kt | 2 +- .../kotlin/crypto/sample/FileWrapper.kt | 8 +++---- 9 files changed, 42 insertions(+), 22 deletions(-) create mode 100644 multiplatform-crypto-libsodium-bindings/src/commonMain/kotlin/com.ionspin.kotlin.crypto/CryptoModule.md create mode 100644 multiplatform-crypto-libsodium-bindings/src/commonMain/kotlin/com.ionspin.kotlin.crypto/aead/Aead.md diff --git a/buildSrc/src/main/kotlin/Deps.kt b/buildSrc/src/main/kotlin/Deps.kt index 395c929..e52ba03 100644 --- a/buildSrc/src/main/kotlin/Deps.kt +++ b/buildSrc/src/main/kotlin/Deps.kt @@ -15,13 +15,13 @@ */ object Versions { - val kotlinCoroutines = "1.3.9" + val kotlinCoroutines = "1.4.1" val kotlin = "1.4.10" val kotlinSerialization = "1.0.0" val kotlinSerializationPlugin = "1.4.10" val atomicfu = "0.14.3-M2-2-SNAPSHOT" //NOTE: my linux arm32 and arm64 build val nodePlugin = "1.3.0" - val dokkaPlugin = "1.4.0-rc" + val dokkaPlugin = "1.4.0" val taskTreePlugin = "1.5" val kotlinBigNumVersion = "0.2.2" val lazySodium = "4.3.1-SNAPSHOT" diff --git a/multiplatform-crypto-api/build.gradle.kts b/multiplatform-crypto-api/build.gradle.kts index 7cb696a..4c655f0 100644 --- a/multiplatform-crypto-api/build.gradle.kts +++ b/multiplatform-crypto-api/build.gradle.kts @@ -19,6 +19,7 @@ import org.jetbrains.kotlin.gradle.targets.js.testing.KotlinJsTest import org.jetbrains.kotlin.gradle.targets.native.tasks.KotlinNativeTest +import org.jetbrains.dokka.Platform plugins { kotlin(PluginsDeps.multiplatform) @@ -275,9 +276,9 @@ tasks { dokkaJavadoc { println("Dokka !") dokkaSourceSets { - create("commonMain") { - displayName = "common" - platform = "common" + named("commonMain") { + displayName.set("common") + platform.set(Platform.common) } } diff --git a/multiplatform-crypto-delegated/build.gradle.kts b/multiplatform-crypto-delegated/build.gradle.kts index 77b5912..0515eff 100644 --- a/multiplatform-crypto-delegated/build.gradle.kts +++ b/multiplatform-crypto-delegated/build.gradle.kts @@ -20,6 +20,7 @@ import org.jetbrains.kotlin.gradle.plugin.mpp.KotlinNativeTarget import org.jetbrains.kotlin.gradle.targets.js.testing.KotlinJsTest import org.jetbrains.kotlin.gradle.targets.native.tasks.KotlinNativeTest +import org.jetbrains.dokka.Platform plugins { kotlin(PluginsDeps.multiplatform) @@ -566,9 +567,9 @@ tasks { dokkaJavadoc { println("Dokka !") dokkaSourceSets { - create("commonMain") { - displayName = "common" - platform = "common" + named("commonMain") { + displayName.set("common") + platform.set(Platform.common) } } diff --git a/multiplatform-crypto-libsodium-bindings/build.gradle.kts b/multiplatform-crypto-libsodium-bindings/build.gradle.kts index fb12465..5c00c55 100644 --- a/multiplatform-crypto-libsodium-bindings/build.gradle.kts +++ b/multiplatform-crypto-libsodium-bindings/build.gradle.kts @@ -20,6 +20,7 @@ import org.jetbrains.kotlin.gradle.plugin.mpp.KotlinNativeTarget import org.jetbrains.kotlin.gradle.targets.js.testing.KotlinJsTest import org.jetbrains.kotlin.gradle.targets.native.tasks.KotlinNativeTest +import org.jetbrains.dokka.Platform plugins { kotlin(PluginsDeps.multiplatform) @@ -593,9 +594,9 @@ tasks { dokkaJavadoc { println("Dokka !") dokkaSourceSets { - create("commonMain") { - displayName = "common" - platform = "common" + named("commonMain") { + displayName.set("common") + platform.set(Platform.common) } } @@ -605,9 +606,18 @@ tasks { dokkaHtml { println("Dokka Html!") dokkaSourceSets { - create("commonMain") { - displayName = "common" - platform = "common" + named("commonMain") { +// displayName.set("common") +// platform.set(Platform.common) + moduleDisplayName.set("Kotlin Multiplatform Libsodium Bindings") + includes.from("src/commonMain/kotlin/com.ionspin.kotlin.crypto/aead/Aead.md", + "src/commonMain/kotlin/com.ionspin.kotlin.crypto/CryptoModule.md") + displayName.set("Kotlin multiplatform") + } + configureEach { + if (name != "commonMain") { + suppress.set(true) + } } } } diff --git a/multiplatform-crypto-libsodium-bindings/src/commonMain/kotlin/com.ionspin.kotlin.crypto/CryptoModule.md b/multiplatform-crypto-libsodium-bindings/src/commonMain/kotlin/com.ionspin.kotlin.crypto/CryptoModule.md new file mode 100644 index 0000000..2c3c0a5 --- /dev/null +++ b/multiplatform-crypto-libsodium-bindings/src/commonMain/kotlin/com.ionspin.kotlin.crypto/CryptoModule.md @@ -0,0 +1,3 @@ +# Module Kotlin Multiplatform Libsodium Bindings + +Test test test diff --git a/multiplatform-crypto-libsodium-bindings/src/commonMain/kotlin/com.ionspin.kotlin.crypto/aead/Aead.md b/multiplatform-crypto-libsodium-bindings/src/commonMain/kotlin/com.ionspin.kotlin.crypto/aead/Aead.md new file mode 100644 index 0000000..b302ce5 --- /dev/null +++ b/multiplatform-crypto-libsodium-bindings/src/commonMain/kotlin/com.ionspin.kotlin.crypto/aead/Aead.md @@ -0,0 +1,4 @@ +# Package com.ionspin.kotlin.crypto.aead + +Package AEAD stuff here + diff --git a/multiplatform-crypto/build.gradle.kts b/multiplatform-crypto/build.gradle.kts index d458d71..f7dd2a6 100644 --- a/multiplatform-crypto/build.gradle.kts +++ b/multiplatform-crypto/build.gradle.kts @@ -18,6 +18,7 @@ @file:Suppress("UnstableApiUsage") import org.jetbrains.kotlin.gradle.targets.native.tasks.KotlinNativeTest import org.jetbrains.kotlin.gradle.targets.js.testing.KotlinJsTest +import org.jetbrains.dokka.Platform plugins { kotlin(PluginsDeps.multiplatform) @@ -401,9 +402,9 @@ tasks { dokkaJavadoc { println("Dokka !") dokkaSourceSets { - create("commonMain") { - displayName = "common" - platform = "common" + named("commonMain") { + displayName.set("common") + platform.set(Platform.common) } } diff --git a/sample/src/commonMain/kotlin/com/ionspin/kotlin/crypto/sample/DataPackage.kt b/sample/src/commonMain/kotlin/com/ionspin/kotlin/crypto/sample/DataPackage.kt index b6e85ca..9dca8ac 100644 --- a/sample/src/commonMain/kotlin/com/ionspin/kotlin/crypto/sample/DataPackage.kt +++ b/sample/src/commonMain/kotlin/com/ionspin/kotlin/crypto/sample/DataPackage.kt @@ -33,4 +33,4 @@ data class HexadecimalStringData(val content: String) : DataPackage { } } -data class FileData(val filePath: ) +//data class FileData(val filePath: ) diff --git a/sample/src/commonMain/kotlin/com/ionspin/kotlin/crypto/sample/FileWrapper.kt b/sample/src/commonMain/kotlin/com/ionspin/kotlin/crypto/sample/FileWrapper.kt index bc3411a..8e874a2 100644 --- a/sample/src/commonMain/kotlin/com/ionspin/kotlin/crypto/sample/FileWrapper.kt +++ b/sample/src/commonMain/kotlin/com/ionspin/kotlin/crypto/sample/FileWrapper.kt @@ -5,7 +5,7 @@ package com.ionspin.kotlin.crypto.sample * ugljesa.jovanovic@ionspin.com * on 30-Oct-2020 */ -expect class FileWrapper(path: String) { - fun exists() : Boolean - fun rea -} +//expect class FileWrapper(path: String) { +// fun exists() : Boolean +//// fun rea +//}