blob: e3e637537521c8383607fca3641e357fc9c05be3 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
|
package org.jetbrains.dokka.dokkatoo.internal
import kotlin.RequiresOptIn.Level.WARNING
import kotlin.annotation.AnnotationRetention.BINARY
import kotlin.annotation.AnnotationTarget.*
/**
* Functionality that is annotated with this API is intended only for use by Dokkatoo internal code,
* but it has been given
* [`public` visibility](https://kotlinlang.org/docs/visibility-modifiers.html)
* for technical reasons.
*
* Any code that is annotated with this may be used
*
* Anyone is welcome to
* [opt in](https://kotlinlang.org/docs/opt-in-requirements.html#opt-in-to-using-api)
* to use this API, but be aware that it might change unexpectedly and without warning or migration
* hints.
*
* If you find yourself needing to opt in, then please report your use-case on
* [the Dokkatoo issue tracker](https://github.com/adamko-dev/dokkatoo/issues).
*/
@RequiresOptIn(
"Internal API - may change at any time without notice",
level = WARNING
)
@Retention(BINARY)
@Target(
CLASS,
FUNCTION,
CONSTRUCTOR,
PROPERTY,
PROPERTY_GETTER,
)
@MustBeDocumented
annotation class DokkatooInternalApi
|
