Enable Dokka to generate HTML docs (#194)

* Enable Dokka to generate HTML docs
* Added KDoc badge

Module.md

@@ -0,0 +1,20 @@
+# Module binary-compatibility-validator
+
+Binary compatibility validator allows dumping Kotlin library ABI (both for JVM libraries and KLibs) 
+that is public in the sense of Kotlin visibilities and ensures that the public ABI
+wasn't changed in a way that makes this change binary incompatible.
+
+# Package kotlinx.validation
+
+Provides common declarations, Gradle plugin tasks and extensions. 
+
+# Package kotlinx.validation.api
+
+Provides an API for dumping Kotlin Java libraries public ABI.
+
+# Package kotlinx.validation.api.klib
+
+Provides an API for dumping Kotlin libraries (KLibs) public ABI and managing resulting dumps.
+
+**This package is experimental, both API and behaviour may change in the future. There are also no guarantees on preserving the behavior of the API until its
+stabilization.**

README.md

@@ -2,6 +2,7 @@
 [![JetBrains official project](https://jb.gg/badges/official.svg)](https://confluence.jetbrains.com/display/ALL/JetBrains+on+GitHub)
 [![Maven Central](https://img.shields.io/maven-central/v/org.jetbrains.kotlinx/binary-compatibility-validator)](https://central.sonatype.com/search?q=org.jetbrains.kotlinx.binary-compatibility-validator)
 [![License](https://img.shields.io/github/license/Kotlin/binary-compatibility-validator)](LICENSE.TXT)
+[![KDoc link](https://img.shields.io/badge/API_reference-KDoc-blue)](https://kotlin.github.io/binary-compatibility-validator/)
 
 # Binary compatibility validator
 

build.gradle.kts

@@ -3,8 +3,11 @@ import kotlinx.validation.build.mavenCentralMetadata
 import kotlinx.validation.build.mavenRepositoryPublishing
 import kotlinx.validation.build.signPublicationIfKeyPresent
 import org.gradle.api.attributes.TestSuiteType.FUNCTIONAL_TEST
+import org.jetbrains.dokka.gradle.DokkaTask
+import org.jetbrains.dokka.gradle.DokkaTaskPartial
 import org.jetbrains.kotlin.gradle.dsl.JvmTarget
 import org.jetbrains.kotlin.gradle.dsl.KotlinVersion
+import java.net.URL
 
 plugins {
     kotlin("jvm")
@@ -16,6 +19,7 @@ plugins {
     `jvm-test-suite`
     id("org.jetbrains.kotlinx.binary-compatibility-validator")
     alias(libs.plugins.kover)
+    alias(libs.plugins.dokka)
 }
 
 group = "org.jetbrains.kotlinx"
@@ -223,3 +227,17 @@ kover {
         disable()
     }
 }
+
+
+tasks.withType<DokkaTask>().configureEach {
+    dokkaSourceSets.configureEach {
+        includes.from("Module.md")
+
+        sourceLink {
+            localDirectory.set(rootDir)
+            remoteUrl.set(URL("https://github.com/Kotlin/binary-compatibility-validator/tree/master"))
+            remoteLineSuffix.set("#L")
+        }
+        samples.from("src/test/kotlin/samples/KlibDumpSamples.kt")
+    }
+}

gradle/libs.versions.toml

@@ -7,6 +7,7 @@ junit = "5.9.2"
 kotest = "5.5.5"
 kotlinx-bcv = "0.13.1"
 ow2Asm = "9.6"
+dokka = "1.9.20"
 
 gradlePluginPublishPlugin = "1.1.0"
 androidGradlePlugin = "7.2.2"
@@ -44,3 +45,4 @@ gradlePlugin-android = { module = "com.android.tools.build:gradle", version.ref
 [plugins]
 
 kover = { id = "org.jetbrains.kotlinx.kover", version = "0.7.5" }
+dokka = { id = "org.jetbrains.dokka", version.ref = "dokka" }