Update/expand website and API documentation (#133)

erikc5000 · Aug 26, 2020 · 4e205a4 · 4e205a4
1 parent 09a225e
commit 4e205a4
Show file tree

Hide file tree

Showing 14 changed files with 193 additions and 101 deletions.
diff --git a/.github/workflows/deploy-website.yaml b/.github/workflows/deploy-website.yaml
@@ -20,9 +20,7 @@ jobs:
         run: pip install mkdocs-material mkdocs-macros-plugin
 
       - name: Build API docs
-        run: |
-          ./gradlew assemble
-          ./gradlew generateMkdocsApiDocs
+        run: ./gradlew mkdocsDokka
 
       - name: Deploy
-        run: mkdocs gh-deploy --force
+        run: mkdocs gh-deploy --force
diff --git a/README.md b/README.md
@@ -15,8 +15,9 @@ Features:
 - Convert to and from platform-specific date-time types
 - Works on JVM, Android, iOS, macOS, tvOS, and watchOS
 
-Current limitations:
+Notable Limitations:
 - No custom format strings (must write platform-specific code to do this)
+- No support for JavaScript or non-Apple native platforms
 - Only supports the ISO calendar system
 
 Island Time is still early in development and "moving fast" so to speak. The API is likely to experience changes between minor version increments.

diff --git a/build.gradle.kts b/build.gradle.kts
@@ -13,10 +13,6 @@ buildscript {
     }
 }
 
-plugins {
-    id("org.jetbrains.dokka")
-}
-
 subprojects {
     tasks.withType<JavaCompile>().configureEach {
         sourceCompatibility = JavaVersion.VERSION_1_8.toString()

diff --git a/buildSrc/build.gradle.kts b/buildSrc/build.gradle.kts
@@ -15,7 +15,7 @@ dependencies {
     implementation(kotlin("gradle-plugin"))
     implementation(kotlin("stdlib-jdk8"))
     implementation(kotlin("reflect"))
-    implementation("org.jetbrains.dokka:dokka-gradle-plugin:1.4.0-dev-38")
+    implementation("org.jetbrains.dokka:dokka-gradle-plugin:1.4.0-dev-53")
     implementation("com.android.tools.build:gradle:4.0.1")
 }
 

diff --git a/core/src/commonMain/kotlin/io/islandtime/clock/Clock.kt b/core/src/commonMain/kotlin/io/islandtime/clock/Clock.kt
@@ -9,7 +9,7 @@ import io.islandtime.internal.deprecatedToError
 import io.islandtime.measures.*
 
 /**
- * A time source.
+ * An abstraction providing the current time.
  *
  * For an implementation that uses the system's clock, see [SystemClock]. [FixedClock] is also available for testing
  * purposes.
@@ -19,7 +19,7 @@ import io.islandtime.measures.*
  */
 interface Clock {
     /**
-     * The clock's time zone.
+     * The time zone of this clock.
      */
     val zone: TimeZone