Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Introduce InternalDokkaApi annotation (#2904)
* Introduce InternalDokkaApi annotation Rationale: dokka-core has a long history of bloating its API shape with utilities that were never intended to be public, and that may expose unwanted implementation details, as well as unwanted compatibility burdens. Eventually, we would like to get rid of them (i.e. by making them internal), but first, it would be nice to provide users with an explicit message about it
- Loading branch information
Showing
4 changed files
with
34 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
package org.jetbrains.dokka | ||
|
||
|
||
/** | ||
* Marks declarations that are **internal** to Dokka core artifact. | ||
* It means that this API is marked as **public** either for historical or technical reasons. | ||
* It is not intended to be used outside of the Dokka project, has no behaviour guarantees, | ||
* and may lack clear semantics, documentation and backward compatibility. | ||
* | ||
* If you are using such API, it is strongly suggested to migrate from it in order | ||
* to keep backwards compatibility with future Dokka versions. | ||
* Typically, the easiest way to do so is to copy-paste the corresponding utility into | ||
* your own project. | ||
*/ | ||
@RequiresOptIn( | ||
level = RequiresOptIn.Level.ERROR, | ||
message = "This is an internal Dokka API not intended for public use" | ||
) | ||
@Target(AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.FIELD) | ||
@Retention(AnnotationRetention.BINARY) | ||
public annotation class InternalDokkaApi() |
3 changes: 3 additions & 0 deletions
3
core/src/main/kotlin/utilities/SelfRepresentingSingletonSet.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters