Suppress dokka warnings for external classes exposing JS API to Kotlin

Usually MDN link in the class description is enough.
This commit is contained in:
Ilya Gorbunov
2018-04-20 05:31:34 +03:00
parent b93e385181
commit 481620ba32
5 changed files with 7 additions and 1 deletions
+1
View File
@@ -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)
+2 -1
View File
@@ -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
+1
View File
@@ -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
@@ -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<out T>(executor: (resolve: (T) -> Unit, reject: (Throwable) -> Unit) -> Unit) {
@LowPriorityInOverloadResolution
public open fun <S> then(onFulfilled: ((T) -> S)?): Promise<S>
+2
View File
@@ -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