Add Dokka support (#231)

Fixes #192

Author: dkhalanskyjb

core/build.gradle.kts

@@ -5,10 +5,12 @@ import java.util.Locale
 import javax.xml.parsers.DocumentBuilderFactory
 import java.io.ByteArrayOutputStream
 import java.io.PrintWriter
+import org.jetbrains.dokka.gradle.AbstractDokkaLeafTask
 
 plugins {
     kotlin("multiplatform")
     kotlin("plugin.serialization")
+    id("org.jetbrains.dokka")
     `maven-publish`
 }
 
@@ -343,3 +345,15 @@ val downloadWindowsZonesMapping by tasks.registering {
         }
     }
 }
+
+tasks.withType<AbstractDokkaLeafTask>().configureEach {
+    dokkaSourceSets.configureEach {
+        // reportUndocumented.set(true) // much noisy output about `hashCode` and serializer encoders, decoders etc
+        skipDeprecated.set(true)
+        // hide the `internal` package, which, on JS, has public members generated by Dukat that would get mentioned
+        perPackageOption {
+            matchingRegex.set(".*\\.internal\\..*")
+            suppress.set(true)
+        }
+    }
+}

core/common/src/Exceptions.kt

@@ -5,13 +5,19 @@
 
 package kotlinx.datetime
 
+/**
+ * Thrown by date-time arithmetic operations if the result can not be computed or represented.
+ */
 public class DateTimeArithmeticException: RuntimeException {
     public constructor(): super()
     public constructor(message: String): super(message)
     public constructor(cause: Throwable): super(cause)
     public constructor(message: String, cause: Throwable): super(message, cause)
 }
 
+/**
+ * Thrown when attempting to construct a [TimeZone] with an invalid ID.
+ */
 public class IllegalTimeZoneException: IllegalArgumentException {
     public constructor(): super()
     public constructor(message: String): super(message)

gradle.properties

@@ -6,6 +6,7 @@ version=0.4.0
 versionSuffix=SNAPSHOT
 
 kotlinVersion=1.7.0
+dokkaVersion=1.7.0
 serializationVersion=1.3.2
 
 java.mainToolchainVersion=8

settings.gradle.kts

@@ -5,9 +5,11 @@ pluginManagement {
         gradlePluginPortal()
     }
     val kotlinVersion: String by settings
+    val dokkaVersion: String by settings
     plugins {
         kotlin("multiplatform") version kotlinVersion
         kotlin("plugin.serialization") version kotlinVersion
+        id("org.jetbrains.dokka") version dokkaVersion
     }
 }