Package eu.xenit.gradle.enterprise.conventions.api

Annotation Interface PublicApi

@Target({TYPE,METHOD,FIELD})
@Retention(SOURCE)
@Documented
public @interface PublicApi

This annotation is used to denote a class or method as part of the public API that can be used by end-users. It means that this API will not change within a release in a way that would make it no longer compatible with an earlier version.

When a class is designated as public api, it means that the class name itself will not change, it does not indicate anything about methods or fields inside the class. In fact, all non-annotated fields and methods are not public API.