document actual funcs

Signed-off-by: Adam Ratzman <[email protected]>

Author: adamint

src/androidMain/kotlin/com/adamratzman/spotify/Pkce.kt

@@ -6,6 +6,9 @@ import android.os.Build.VERSION_CODES
 import android.util.Base64
 import java.security.MessageDigest
 
+/**
+ * A utility to get the pkce code challenge for a corresponding code verifier. Only available on JVM/Android
+ */
 public actual fun getSpotifyPkceCodeChallenge(codeVerifier: String): String {
     val sha256 = MessageDigest.getInstance("SHA-256").digest(codeVerifier.toByteArray())
     return if (VERSION.SDK_INT >= VERSION_CODES.O) {

src/androidMain/kotlin/com/adamratzman/spotify/utils/Concurrency.kt

@@ -1,4 +1,7 @@
 /* Spotify Web API, Kotlin Wrapper; MIT License, 2017-2021; Original author: Adam Ratzman */
 package com.adamratzman.spotify.utils
 
+/**
+ * Represents a unit of time
+ */
 public actual typealias TimeUnit = java.util.concurrent.TimeUnit

src/androidMain/kotlin/com/adamratzman/spotify/utils/Misc.kt

@@ -1,4 +1,7 @@
 /* Spotify Web API, Kotlin Wrapper; MIT License, 2017-2021; Original author: Adam Ratzman */
 package com.adamratzman.spotify.utils
 
+/**
+ * The current time in milliseconds since UNIX epoch.
+ */
 public actual fun getCurrentTimeMs(): Long = System.currentTimeMillis()

src/androidMain/kotlin/com/adamratzman/spotify/utils/Platform.kt

@@ -1,4 +1,7 @@
 /* Spotify Web API, Kotlin Wrapper; MIT License, 2017-2021; Original author: Adam Ratzman */
 package com.adamratzman.spotify.utils
 
+/**
+ * Actual platform that this program is run on.
+ */
 public actual val platform: Platform = Platform.ANDROID

src/commonMain/kotlin/com.adamratzman.spotify/utils/Concurrency.kt

@@ -1,6 +1,9 @@
 /* Spotify Web API, Kotlin Wrapper; MIT License, 2017-2021; Original author: Adam Ratzman */
 package com.adamratzman.spotify.utils
 
+/**
+ * Represents a unit of time
+ */
 public expect enum class TimeUnit {
     MILLISECONDS, SECONDS;
 

src/commonMain/kotlin/com.adamratzman.spotify/utils/Utils.kt

@@ -8,6 +8,9 @@ import kotlinx.datetime.TimeZone
 import kotlinx.datetime.toLocalDateTime
 import kotlinx.serialization.json.JsonElement
 
+/**
+ * The current time in milliseconds since UNIX epoch.
+ */
 public expect fun getCurrentTimeMs(): Long
 
 internal fun jsonMap(vararg pairs: Pair<String, JsonElement>) = pairs.toMap().toMutableMap()

src/desktopMain/kotlin/com/adamratzman/spotify/utils/Concurrency.kt

@@ -1,7 +1,9 @@
 /* Spotify Web API, Kotlin Wrapper; MIT License, 2017-2021; Original author: Adam Ratzman */
 package com.adamratzman.spotify.utils
 
-@Suppress("unused")
+/**
+ * Represents a unit of time
+ */
 public actual enum class TimeUnit(public val multiplier: Int) {
     MILLISECONDS(1), SECONDS(1000), MINUTES(60000);
 

src/desktopMain/kotlin/com/adamratzman/spotify/utils/Misc.kt

@@ -3,6 +3,9 @@ package com.adamratzman.spotify.utils
 
 import kotlin.system.getTimeMillis
 
+/**
+ * The current time in milliseconds since UNIX epoch.
+ */
 public actual fun getCurrentTimeMs(): Long {
     return getTimeMillis()
 }

src/desktopMain/kotlin/com/adamratzman/spotify/utils/Platform.kt

@@ -1,4 +1,7 @@
 /* Spotify Web API, Kotlin Wrapper; MIT License, 2017-2021; Original author: Adam Ratzman */
 package com.adamratzman.spotify.utils
 
+/**
+ * Actual platform that this program is run on.
+ */
 public actual val platform: Platform = Platform.NATIVE

src/jsMain/kotlin/com/adamratzman/spotify/utils/Concurrency.kt

@@ -1,7 +1,9 @@
 /* Spotify Web API, Kotlin Wrapper; MIT License, 2017-2021; Original author: Adam Ratzman */
 package com.adamratzman.spotify.utils
 
-@Suppress("unused")
+/**
+ * Represents a unit of time
+ */
 public actual enum class TimeUnit(public val multiplier: Int) {
     MILLISECONDS(1), SECONDS(1000), MINUTES(60000);