api_common_annotations/com.tomtom.ivi.platform.gradle.api.common.annotations

Package-level declarations

This package contains annotations that can be used, for instance, to mark that a functionality is not backward compatible.

Types

IviDslMarker

@DslMarker

annotation class IviDslMarker

Marks the annotated type as DSL language.

IviGradleExperimentalApi

typealias IviGradleExperimentalApi = Deprecated

This annotation marks TomTom Digital Cockpit's Gradle plugin API modules as experimental.

Note: While functionality from TomTom Digital Cockpit's Gradle plugin API modules are typically kept backward compatible, classes or methods marked with this annotation are not guaranteed to be backward compatible. It is used to expose certain functionality to clients sooner on the condition that they accept the cost of updating their code when integrating a newer version of TomTom Digital Cockpit.

This is a typealias to the Deprecated annotation. This as Kotlin's RequiresOptIn can not be used in combination with op-ins in build.gradle.kts files. It is impossible to configure the Kotlin compiler arguments used for compiling the scripts. Customers can opt-in by suppressing the deprecation warning.

IviGradleInternal

typealias IviGradleInternal = Deprecated

This annotation marks TomTom Digital Cockpit API modules as internal.

Note: While the functionality of TomTom Digital Cockpit API modules is typically kept backward compatible, classes or methods marked with this annotation are not guaranteed to be backward compatible. It is used to mark some properties and classes which are used internally by generated code and should not be used directly by a plugin.

Properties

EXPERIMENTAL_API_MESSAGE

const val EXPERIMENTAL_API_MESSAGE: String

Message for the IviGradleExperimentalApi annotation.

EXPERIMENTAL_API_OVERRIDE_USAGE_MEMBER

const val EXPERIMENTAL_API_OVERRIDE_USAGE_MEMBER: String

Value to use to suppress overriding deprecated member warnings caused by IviGradleExperimentalApi.

EXPERIMENTAL_API_USAGE

const val EXPERIMENTAL_API_USAGE: String

Value to use to suppress warnings caused by IviGradleExperimentalApi.

INTERNAL_MESSAGE

const val INTERNAL_MESSAGE: String

Message for the IviGradleInternal annotation.

INTERNAL_OVERRIDE_USAGE_MEMBER

const val INTERNAL_OVERRIDE_USAGE_MEMBER: String

Value to use to suppress overriding deprecated member warnings caused by IviGradleInternal.

INTERNAL_TYPEALIAS_USAGE

const val INTERNAL_TYPEALIAS_USAGE: String

Value to use to suppress deprecated typealias expansion warnings caused by IviGradleInternal.

INTERNAL_USAGE

const val INTERNAL_USAGE: String

Value to use to suppress deprecated usages warnings caused by IviGradleInternal.