From 481620ba32908f4af22401e43aed27e9b37e3867 Mon Sep 17 00:00:00 2001 From: Ilya Gorbunov Date: Fri, 20 Apr 2018 05:31:34 +0300 Subject: [PATCH] Suppress dokka warnings for external classes exposing JS API to Kotlin Usually MDN link in the class description is enough. --- libraries/stdlib/js/src/kotlin/date.kt | 1 + libraries/stdlib/js/src/kotlin/debug.kt | 3 ++- libraries/stdlib/js/src/kotlin/json.kt | 1 + libraries/stdlib/js/src/kotlin/promise.kt | 1 + libraries/stdlib/js/src/kotlin/regexp.kt | 2 ++ 5 files changed, 7 insertions(+), 1 deletion(-) diff --git a/libraries/stdlib/js/src/kotlin/date.kt b/libraries/stdlib/js/src/kotlin/date.kt index 1a3a4aa6dab..6f20d71f5ae 100644 --- a/libraries/stdlib/js/src/kotlin/date.kt +++ b/libraries/stdlib/js/src/kotlin/date.kt @@ -3,6 +3,7 @@ package kotlin.js /** * Exposes the [Date API](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) to Kotlin. */ +@Suppress("NOT_DOCUMENTED") public external class Date() { public constructor(milliseconds: Number) diff --git a/libraries/stdlib/js/src/kotlin/debug.kt b/libraries/stdlib/js/src/kotlin/debug.kt index b57ff051fb8..6a10624431a 100644 --- a/libraries/stdlib/js/src/kotlin/debug.kt +++ b/libraries/stdlib/js/src/kotlin/debug.kt @@ -3,7 +3,8 @@ package kotlin.js /** * Exposes the [console API](https://developer.mozilla.org/en/DOM/console) to Kotlin. */ -external public interface Console { +@Suppress("NOT_DOCUMENTED") +public external interface Console { public fun dir(o: Any): Unit public fun error(vararg o: Any?): Unit public fun info(vararg o: Any?): Unit diff --git a/libraries/stdlib/js/src/kotlin/json.kt b/libraries/stdlib/js/src/kotlin/json.kt index 2bd6b071894..eddd959f49c 100644 --- a/libraries/stdlib/js/src/kotlin/json.kt +++ b/libraries/stdlib/js/src/kotlin/json.kt @@ -72,6 +72,7 @@ public fun Json.add(other: Json): Json { /** * Exposes the JavaScript [JSON object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON) to Kotlin. */ +@Suppress("NOT_DOCUMENTED") public external object JSON { public fun stringify(o: Any?): String public fun stringify(o: Any?, replacer: ((key: String, value: Any?) -> Any?)): String diff --git a/libraries/stdlib/js/src/kotlin/promise.kt b/libraries/stdlib/js/src/kotlin/promise.kt index 34ec68a2165..3b02201ae46 100644 --- a/libraries/stdlib/js/src/kotlin/promise.kt +++ b/libraries/stdlib/js/src/kotlin/promise.kt @@ -21,6 +21,7 @@ import kotlin.internal.LowPriorityInOverloadResolution /** * Exposes the JavaScript [Promise object](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Promise) to Kotlin. */ +@Suppress("NOT_DOCUMENTED") public open external class Promise(executor: (resolve: (T) -> Unit, reject: (Throwable) -> Unit) -> Unit) { @LowPriorityInOverloadResolution public open fun then(onFulfilled: ((T) -> S)?): Promise diff --git a/libraries/stdlib/js/src/kotlin/regexp.kt b/libraries/stdlib/js/src/kotlin/regexp.kt index 038ab82f9b0..1494bb6bd95 100644 --- a/libraries/stdlib/js/src/kotlin/regexp.kt +++ b/libraries/stdlib/js/src/kotlin/regexp.kt @@ -19,6 +19,7 @@ package kotlin.js /** * Exposes the JavaScript [RegExp object](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/RegExp) to Kotlin. */ +@Suppress("NOT_DOCUMENTED") public external class RegExp(pattern: String, flags: String? = definedExternally) { public fun test(str: String): Boolean @@ -48,6 +49,7 @@ public fun RegExp.reset() { /** * Represents the return value of [RegExp.exec]. */ +@Suppress("NOT_DOCUMENTED") public external interface RegExpMatch { public val index: Int public val input: String