Kone: Annotations

This module provides common annotations that are used all over Kone library.

Applying the dependencies

Gradle Kotlin DSL

build.gradle.kts

dependencies {
    implementation("dev.lounres:kone.annotations:0.0.0-experiment")
}

Gradle Groovy DSL

build.gradle

dependencies {
    implementation 'dev.lounres:kone.annotations:0.0.0-experiment'
}

Maven

pom.xml

<dependency>
    <groupId>dev.lounres</groupId>
    <artifactId>kone.annotations</artifactId>
    <version>0.0.0-experiment</version>
</dependency>

API stability annotations

There are two annotations specifically made for unstable and experimental APIs:

1. UnstableKoneAPI is used to mark parts of Kone API that have more or less certain shape but which final form is not yet finished.
2. ExperimentalKoneAPI is used to mark parts of Kone API that are just sketches of possible API. Their main purpose is only to gather ideas of the API and check which parts of it should be rewritten from scratch.

note

For now, the annotations are not used, because none of Kone's modules are ready for the first public release.