From 8193c2534f7e0b69bc13b3c1305519fc038a365b Mon Sep 17 00:00:00 2001 From: Adam Semenenko <152864218+adam-enko@users.noreply.github.com> Date: Wed, 16 Oct 2024 17:44:32 +0200 Subject: [PATCH] Rename `DokkaInternalApi` to `InternalDokkaGradlePluginApi` KT-72266 --- .../tasks/GenerateDokkaGradlePluginConstants.kt | 2 +- .../dokka-gradle-plugin/api/dokka-gradle-plugin.api | 2 +- dokka-runners/dokka-gradle-plugin/build.gradle.kts | 4 ++-- .../src/main/kotlin/DokkaBasePlugin.kt | 2 +- .../src/main/kotlin/DokkaExtension.kt | 4 ++-- .../src/main/kotlin/DokkaPlugin.kt | 4 ++-- .../src/main/kotlin/adapters/AndroidAdapter.kt | 6 +++--- .../src/main/kotlin/adapters/JavaAdapter.kt | 6 +++--- .../src/main/kotlin/adapters/KotlinAdapter.kt | 8 ++++---- .../kotlin/dependencies/BaseDependencyManager.kt | 4 ++-- .../kotlin/dependencies/DependencyContainerNames.kt | 4 ++-- .../src/main/kotlin/dependencies/DokkaAttribute.kt | 12 ++++++------ .../kotlin/dependencies/FormatDependenciesManager.kt | 2 +- .../dependencies/ModuleComponentDependencies.kt | 4 ++-- .../src/main/kotlin/dependencies/attributeValues.kt | 6 +++--- .../parameters/DokkaExternalDocumentationLinkSpec.kt | 4 ++-- .../parameters/DokkaGeneratorParametersSpec.kt | 4 ++-- .../engine/parameters/DokkaModuleDescriptionKxs.kt | 4 ++-- .../engine/parameters/DokkaPackageOptionsSpec.kt | 4 ++-- .../kotlin/engine/parameters/DokkaSourceLinkSpec.kt | 6 +++--- .../kotlin/engine/parameters/DokkaSourceSetSpec.kt | 4 ++-- .../main/kotlin/engine/parameters/SourceSetIdSpec.kt | 6 +++--- .../parameters/builders/DokkaParametersBuilder.kt | 4 ++-- .../parameters/builders/DokkaSourceSetBuilder.kt | 4 ++-- .../engine/plugins/DokkaHtmlPluginParameters.kt | 4 ++-- .../engine/plugins/DokkaPluginParametersBaseSpec.kt | 4 ++-- .../engine/plugins/DokkaPluginParametersBuilder.kt | 4 ++-- .../plugins/DokkaVersioningPluginParameters.kt | 4 ++-- .../src/main/kotlin/formats/DokkaFormatPlugin.kt | 12 ++++++------ .../src/main/kotlin/formats/DokkaFormatTasks.kt | 4 ++-- .../src/main/kotlin/formats/DokkaHtmlPlugin.kt | 6 +++--- .../src/main/kotlin/formats/DokkaJavadocPlugin.kt | 4 ++-- .../src/main/kotlin/formats/DokkaPublication.kt | 4 ++-- .../src/main/kotlin/internal/HasFormatName.kt | 2 +- ...nternalApi.kt => InternalDokkaGradlePluginApi.kt} | 2 +- .../main/kotlin/internal/PluginFeaturesService.kt | 2 +- .../src/main/kotlin/tasks/DokkaBaseTask.kt | 4 ++-- .../src/main/kotlin/tasks/DokkaGenerateModuleTask.kt | 4 ++-- .../kotlin/tasks/DokkaGeneratePublicationTask.kt | 4 ++-- .../src/main/kotlin/tasks/DokkaGenerateTask.kt | 10 +++++----- .../main/kotlin/tasks/LogHtmlPublicationLinkTask.kt | 4 ++-- .../src/main/kotlin/tasks/TaskNames.kt | 4 ++-- .../src/main/kotlin/workers/DokkaGeneratorWorker.kt | 8 ++++---- 43 files changed, 100 insertions(+), 100 deletions(-) rename dokka-runners/dokka-gradle-plugin/src/main/kotlin/internal/{DokkaInternalApi.kt => InternalDokkaGradlePluginApi.kt} (96%) diff --git a/build-logic/src/main/kotlin/dokkabuild/tasks/GenerateDokkaGradlePluginConstants.kt b/build-logic/src/main/kotlin/dokkabuild/tasks/GenerateDokkaGradlePluginConstants.kt index 61ad3f7ac8..84f52e14ef 100644 --- a/build-logic/src/main/kotlin/dokkabuild/tasks/GenerateDokkaGradlePluginConstants.kt +++ b/build-logic/src/main/kotlin/dokkabuild/tasks/GenerateDokkaGradlePluginConstants.kt @@ -48,7 +48,7 @@ abstract class GenerateDokkaGradlePluginConstants @Inject constructor( | */ |package org.jetbrains.dokka.gradle.internal | - |@DokkaInternalApi + |@InternalDokkaGradlePluginApi |object DokkaConstants { |$vals |} diff --git a/dokka-runners/dokka-gradle-plugin/api/dokka-gradle-plugin.api b/dokka-runners/dokka-gradle-plugin/api/dokka-gradle-plugin.api index 87fd0b9688..c57d8d624c 100644 --- a/dokka-runners/dokka-gradle-plugin/api/dokka-gradle-plugin.api +++ b/dokka-runners/dokka-gradle-plugin/api/dokka-gradle-plugin.api @@ -525,7 +525,7 @@ public final class org/jetbrains/dokka/gradle/internal/AbstractDokkaTaskExtensio public static synthetic fun buildJsonConfiguration$default (Lorg/jetbrains/dokka/gradle/AbstractDokkaTask;ZILjava/lang/Object;)Ljava/lang/String; } -public abstract interface annotation class org/jetbrains/dokka/gradle/internal/DokkaInternalApi : java/lang/annotation/Annotation { +public abstract interface annotation class org/jetbrains/dokka/gradle/internal/InternalDokkaGradlePluginApi : java/lang/annotation/Annotation { } public final class org/jetbrains/dokka/gradle/internal/V2MigrationUtilsKt$inlined$sam$i$org_gradle_api_Action$0 : org/gradle/api/Action { diff --git a/dokka-runners/dokka-gradle-plugin/build.gradle.kts b/dokka-runners/dokka-gradle-plugin/build.gradle.kts index 9c17f64f31..7e80391eee 100644 --- a/dokka-runners/dokka-gradle-plugin/build.gradle.kts +++ b/dokka-runners/dokka-gradle-plugin/build.gradle.kts @@ -26,7 +26,7 @@ kotlin { compilerOptions { optIn.addAll( "kotlin.RequiresOptIn", - "org.jetbrains.dokka.gradle.internal.DokkaInternalApi", + "org.jetbrains.dokka.gradle.internal.InternalDokkaGradlePluginApi", "kotlin.io.path.ExperimentalPathApi", ) } @@ -208,7 +208,7 @@ testing.suites { skipTestFixturesPublications() apiValidation { - nonPublicMarkers.add("org.jetbrains.dokka.gradle.internal.DokkaInternalApi") + nonPublicMarkers.add("org.jetbrains.dokka.gradle.internal.InternalDokkaGradlePluginApi") } val generateDokkaGradlePluginConstants by tasks.registering(GenerateDokkaGradlePluginConstants::class) { diff --git a/dokka-runners/dokka-gradle-plugin/src/main/kotlin/DokkaBasePlugin.kt b/dokka-runners/dokka-gradle-plugin/src/main/kotlin/DokkaBasePlugin.kt index 68849ed146..d1fb22dbe6 100644 --- a/dokka-runners/dokka-gradle-plugin/src/main/kotlin/DokkaBasePlugin.kt +++ b/dokka-runners/dokka-gradle-plugin/src/main/kotlin/DokkaBasePlugin.kt @@ -40,7 +40,7 @@ import javax.inject.Inject * but does not add any specific config (specifically, it does not create Dokka Publications). */ abstract class DokkaBasePlugin -@DokkaInternalApi +@InternalDokkaGradlePluginApi @Inject constructor( private val providers: ProviderFactory, diff --git a/dokka-runners/dokka-gradle-plugin/src/main/kotlin/DokkaExtension.kt b/dokka-runners/dokka-gradle-plugin/src/main/kotlin/DokkaExtension.kt index ab5334d8e1..b3b8ad344b 100644 --- a/dokka-runners/dokka-gradle-plugin/src/main/kotlin/DokkaExtension.kt +++ b/dokka-runners/dokka-gradle-plugin/src/main/kotlin/DokkaExtension.kt @@ -24,7 +24,7 @@ import java.io.Serializable * Configure the behaviour of the [DokkaBasePlugin]. */ abstract class DokkaExtension -@DokkaInternalApi +@InternalDokkaGradlePluginApi constructor( private val objects: ObjectFactory, internal val baseDependencyManager: BaseDependencyManager, @@ -100,7 +100,7 @@ constructor( * projects with a version below 2.0. */ // This property should be removed when Dokka only supports KGP 2 or higher. - @DokkaInternalApi + @InternalDokkaGradlePluginApi abstract val konanHome: RegularFileProperty /** diff --git a/dokka-runners/dokka-gradle-plugin/src/main/kotlin/DokkaPlugin.kt b/dokka-runners/dokka-gradle-plugin/src/main/kotlin/DokkaPlugin.kt index 2b9869cf7c..94271db377 100644 --- a/dokka-runners/dokka-gradle-plugin/src/main/kotlin/DokkaPlugin.kt +++ b/dokka-runners/dokka-gradle-plugin/src/main/kotlin/DokkaPlugin.kt @@ -7,7 +7,7 @@ import org.gradle.api.Plugin import org.gradle.api.Project import org.gradle.kotlin.dsl.apply import org.jetbrains.dokka.gradle.formats.DokkaHtmlPlugin -import org.jetbrains.dokka.gradle.internal.DokkaInternalApi +import org.jetbrains.dokka.gradle.internal.InternalDokkaGradlePluginApi import org.jetbrains.dokka.gradle.internal.PluginFeaturesService.Companion.pluginFeaturesService import org.jetbrains.dokka.gradle.internal.addV2MigrationHelpers import javax.inject.Inject @@ -20,7 +20,7 @@ import org.jetbrains.dokka.gradle.DokkaClassicPlugin as ClassicDokkaPlugin */ abstract class DokkaPlugin @Inject -@DokkaInternalApi +@InternalDokkaGradlePluginApi constructor() : Plugin { override fun apply(project: Project) { diff --git a/dokka-runners/dokka-gradle-plugin/src/main/kotlin/adapters/AndroidAdapter.kt b/dokka-runners/dokka-gradle-plugin/src/main/kotlin/adapters/AndroidAdapter.kt index 445eaa0444..34959a20a7 100644 --- a/dokka-runners/dokka-gradle-plugin/src/main/kotlin/adapters/AndroidAdapter.kt +++ b/dokka-runners/dokka-gradle-plugin/src/main/kotlin/adapters/AndroidAdapter.kt @@ -21,7 +21,7 @@ import org.gradle.kotlin.dsl.withType import org.jetbrains.dokka.gradle.DokkaBasePlugin import org.jetbrains.dokka.gradle.DokkaExtension import org.jetbrains.dokka.gradle.engine.parameters.KotlinPlatform -import org.jetbrains.dokka.gradle.internal.DokkaInternalApi +import org.jetbrains.dokka.gradle.internal.InternalDokkaGradlePluginApi import org.jetbrains.dokka.gradle.internal.PluginId import org.jetbrains.dokka.gradle.internal.artifactType import java.io.File @@ -33,7 +33,7 @@ import javax.inject.Inject * This is an internal Dokka plugin and should not be used externally. * It is not a standalone plugin, it requires [org.jetbrains.dokka.gradle.DokkaBasePlugin] is also applied. */ -@DokkaInternalApi +@InternalDokkaGradlePluginApi abstract class AndroidAdapter @Inject constructor( private val objects: ObjectFactory, ) : Plugin { @@ -78,7 +78,7 @@ abstract class AndroidAdapter @Inject constructor( } } - @DokkaInternalApi + @InternalDokkaGradlePluginApi companion object } diff --git a/dokka-runners/dokka-gradle-plugin/src/main/kotlin/adapters/JavaAdapter.kt b/dokka-runners/dokka-gradle-plugin/src/main/kotlin/adapters/JavaAdapter.kt index 95681d74a3..96baf92520 100644 --- a/dokka-runners/dokka-gradle-plugin/src/main/kotlin/adapters/JavaAdapter.kt +++ b/dokka-runners/dokka-gradle-plugin/src/main/kotlin/adapters/JavaAdapter.kt @@ -20,7 +20,7 @@ import org.gradle.kotlin.dsl.withType import org.jetbrains.dokka.gradle.DokkaExtension import org.jetbrains.dokka.gradle.engine.parameters.DokkaSourceSetSpec import org.jetbrains.dokka.gradle.engine.parameters.KotlinPlatform -import org.jetbrains.dokka.gradle.internal.DokkaInternalApi +import org.jetbrains.dokka.gradle.internal.InternalDokkaGradlePluginApi import org.jetbrains.dokka.gradle.internal.PluginId import org.jetbrains.dokka.gradle.internal.or import org.jetbrains.dokka.gradle.internal.uppercaseFirstChar @@ -33,7 +33,7 @@ import javax.inject.Inject * This is an internal Dokka plugin and should not be used externally. * It is not a standalone plugin, it requires [org.jetbrains.dokka.gradle.DokkaBasePlugin] is also applied. */ -@DokkaInternalApi +@InternalDokkaGradlePluginApi abstract class JavaAdapter @Inject constructor( private val providers: ProviderFactory, ) : Plugin { @@ -133,7 +133,7 @@ abstract class JavaAdapter @Inject constructor( return projectHasKotlinPlugin or projectHasAndroidPlugin } - @DokkaInternalApi + @InternalDokkaGradlePluginApi companion object { /** * Determine if a [KotlinCompilation] is 'publishable', and so should be enabled by default diff --git a/dokka-runners/dokka-gradle-plugin/src/main/kotlin/adapters/KotlinAdapter.kt b/dokka-runners/dokka-gradle-plugin/src/main/kotlin/adapters/KotlinAdapter.kt index 2cd22804d5..0ddb47a1d6 100644 --- a/dokka-runners/dokka-gradle-plugin/src/main/kotlin/adapters/KotlinAdapter.kt +++ b/dokka-runners/dokka-gradle-plugin/src/main/kotlin/adapters/KotlinAdapter.kt @@ -50,7 +50,7 @@ import kotlin.reflect.jvm.jvmName * This is an internal Dokka plugin and should not be used externally. * It is not a standalone plugin, it requires [org.jetbrains.dokka.gradle.DokkaBasePlugin] is also applied. */ -@DokkaInternalApi +@InternalDokkaGradlePluginApi abstract class KotlinAdapter @Inject constructor( private val objects: ObjectFactory, private val providers: ProviderFactory, @@ -178,7 +178,7 @@ abstract class KotlinAdapter @Inject constructor( } } - @DokkaInternalApi + @InternalDokkaGradlePluginApi companion object { private val dkaName: String = KotlinAdapter::class.simpleName!! @@ -220,7 +220,7 @@ abstract class KotlinAdapter @Inject constructor( * The compilation details may come from a multiplatform project ([KotlinMultiplatformExtension]) * or a single-platform project ([KotlinSingleTargetExtension]). */ -@DokkaInternalApi +@InternalDokkaGradlePluginApi private data class KotlinCompilationDetails( val target: String, val kotlinPlatform: KotlinPlatform, @@ -400,7 +400,7 @@ private class KotlinCompilationDetailsBuilder( * * @param[named] Should be [KotlinSourceSet.getName] */ -@DokkaInternalApi +@InternalDokkaGradlePluginApi private abstract class KotlinSourceSetDetails @Inject constructor( private val named: String, ) : Named { diff --git a/dokka-runners/dokka-gradle-plugin/src/main/kotlin/dependencies/BaseDependencyManager.kt b/dokka-runners/dokka-gradle-plugin/src/main/kotlin/dependencies/BaseDependencyManager.kt index 509cb32d31..fe880545ca 100644 --- a/dokka-runners/dokka-gradle-plugin/src/main/kotlin/dependencies/BaseDependencyManager.kt +++ b/dokka-runners/dokka-gradle-plugin/src/main/kotlin/dependencies/BaseDependencyManager.kt @@ -8,14 +8,14 @@ import org.gradle.api.artifacts.Configuration import org.gradle.api.model.ObjectFactory import org.jetbrains.dokka.gradle.DokkaBasePlugin.Companion.DOKKA_CONFIGURATION_NAME import org.jetbrains.dokka.gradle.DokkaBasePlugin.Companion.DOKKA_GENERATOR_PLUGINS_CONFIGURATION_NAME -import org.jetbrains.dokka.gradle.internal.DokkaInternalApi +import org.jetbrains.dokka.gradle.internal.InternalDokkaGradlePluginApi import org.jetbrains.dokka.gradle.internal.declarable /** * Root [Configuration] for fetching all types of Dokka files from other subprojects. */ -@DokkaInternalApi +@InternalDokkaGradlePluginApi class BaseDependencyManager( project: Project, objects: ObjectFactory, diff --git a/dokka-runners/dokka-gradle-plugin/src/main/kotlin/dependencies/DependencyContainerNames.kt b/dokka-runners/dokka-gradle-plugin/src/main/kotlin/dependencies/DependencyContainerNames.kt index ce4fac313d..8c7078822e 100644 --- a/dokka-runners/dokka-gradle-plugin/src/main/kotlin/dependencies/DependencyContainerNames.kt +++ b/dokka-runners/dokka-gradle-plugin/src/main/kotlin/dependencies/DependencyContainerNames.kt @@ -6,7 +6,7 @@ package org.jetbrains.dokka.gradle.dependencies import org.gradle.api.artifacts.Configuration import org.jetbrains.dokka.gradle.DokkaBasePlugin import org.jetbrains.dokka.gradle.DokkaBasePlugin.Companion.DOKKA_CONFIGURATION_NAME -import org.jetbrains.dokka.gradle.internal.DokkaInternalApi +import org.jetbrains.dokka.gradle.internal.InternalDokkaGradlePluginApi import org.jetbrains.dokka.gradle.internal.HasFormatName import org.jetbrains.dokka.gradle.internal.INTERNAL_CONF_NAME_TAG @@ -17,7 +17,7 @@ import org.jetbrains.dokka.gradle.internal.INTERNAL_CONF_NAME_TAG * - [Gradle Configurations][org.gradle.api.artifacts.Configuration] - share files between subprojects. Each has a name. * - [DokkaConfiguration][org.jetbrains.dokka.DokkaConfiguration] - parameters for executing the Dokka Generator */ -@DokkaInternalApi +@InternalDokkaGradlePluginApi class DependencyContainerNames(override val formatName: String) : HasFormatName() { /** diff --git a/dokka-runners/dokka-gradle-plugin/src/main/kotlin/dependencies/DokkaAttribute.kt b/dokka-runners/dokka-gradle-plugin/src/main/kotlin/dependencies/DokkaAttribute.kt index 21ff431550..474618b97c 100644 --- a/dokka-runners/dokka-gradle-plugin/src/main/kotlin/dependencies/DokkaAttribute.kt +++ b/dokka-runners/dokka-gradle-plugin/src/main/kotlin/dependencies/DokkaAttribute.kt @@ -7,38 +7,38 @@ import org.gradle.api.Named import org.gradle.api.artifacts.Configuration import org.gradle.api.attributes.Attribute import org.jetbrains.dokka.gradle.internal.Attribute -import org.jetbrains.dokka.gradle.internal.DokkaInternalApi +import org.jetbrains.dokka.gradle.internal.InternalDokkaGradlePluginApi /** * Gradle Configuration Attributes for sharing Dokka files across subprojects. * * These attributes are used to tag [Configuration]s, so files can be shared between subprojects. */ -@DokkaInternalApi +@InternalDokkaGradlePluginApi interface DokkaAttribute { /** HTML, Markdown, etc. */ - @DokkaInternalApi + @InternalDokkaGradlePluginApi class Format(private val named: String) : Named { override fun getName(): String = named override fun toString(): String = "Format($named)" } /** Generated output, or subproject classpath, or included files, etc. */ - @DokkaInternalApi + @InternalDokkaGradlePluginApi class ModuleComponent(private val named: String) : Named { override fun getName(): String = named override fun toString(): String = "ModuleComponent($named)" } /** A classpath, e.g. for Dokka Plugins or the Dokka Generator. */ - @DokkaInternalApi + @InternalDokkaGradlePluginApi class Classpath(private val named: String) : Named { override fun getName(): String = named override fun toString(): String = "Classpath($named)" } - @DokkaInternalApi + @InternalDokkaGradlePluginApi companion object { /** * Describes the type of generated output that Dokka generates. diff --git a/dokka-runners/dokka-gradle-plugin/src/main/kotlin/dependencies/FormatDependenciesManager.kt b/dokka-runners/dokka-gradle-plugin/src/main/kotlin/dependencies/FormatDependenciesManager.kt index b565cb6842..6a4d551715 100644 --- a/dokka-runners/dokka-gradle-plugin/src/main/kotlin/dependencies/FormatDependenciesManager.kt +++ b/dokka-runners/dokka-gradle-plugin/src/main/kotlin/dependencies/FormatDependenciesManager.kt @@ -34,7 +34,7 @@ import org.jetbrains.dokka.gradle.internal.* * [DokkaConfiguration][org.jetbrains.dokka.DokkaConfiguration] * is used to configure Dokka behaviour.) */ -@DokkaInternalApi +@InternalDokkaGradlePluginApi class FormatDependenciesManager( private val formatName: String, private val baseDependencyManager: BaseDependencyManager, diff --git a/dokka-runners/dokka-gradle-plugin/src/main/kotlin/dependencies/ModuleComponentDependencies.kt b/dokka-runners/dokka-gradle-plugin/src/main/kotlin/dependencies/ModuleComponentDependencies.kt index 03a64e7303..6439f1cd62 100644 --- a/dokka-runners/dokka-gradle-plugin/src/main/kotlin/dependencies/ModuleComponentDependencies.kt +++ b/dokka-runners/dokka-gradle-plugin/src/main/kotlin/dependencies/ModuleComponentDependencies.kt @@ -22,7 +22,7 @@ import java.io.File * * Files are shared using variant-aware Gradle [Configuration]s. */ -@DokkaInternalApi +@InternalDokkaGradlePluginApi class ModuleComponentDependencies( project: Project, private val component: DokkaAttribute.ModuleComponent, @@ -130,7 +130,7 @@ class ModuleComponentDependencies( } } - @DokkaInternalApi + @InternalDokkaGradlePluginApi companion object { private val logger: Logger = Logging.getLogger(DokkaAttribute.ModuleComponent::class.java) } diff --git a/dokka-runners/dokka-gradle-plugin/src/main/kotlin/dependencies/attributeValues.kt b/dokka-runners/dokka-gradle-plugin/src/main/kotlin/dependencies/attributeValues.kt index bc834be96b..adb0336278 100644 --- a/dokka-runners/dokka-gradle-plugin/src/main/kotlin/dependencies/attributeValues.kt +++ b/dokka-runners/dokka-gradle-plugin/src/main/kotlin/dependencies/attributeValues.kt @@ -9,11 +9,11 @@ import org.gradle.api.attributes.Usage import org.gradle.api.model.ObjectFactory import org.gradle.kotlin.dsl.named import org.jetbrains.dokka.gradle.internal.Attribute -import org.jetbrains.dokka.gradle.internal.DokkaInternalApi +import org.jetbrains.dokka.gradle.internal.InternalDokkaGradlePluginApi /** Common [Attribute] values for Dokka [Configuration]s. */ -@DokkaInternalApi +@InternalDokkaGradlePluginApi class BaseAttributes( objects: ObjectFactory, ) { @@ -31,7 +31,7 @@ class BaseAttributes( /** [Attribute] values for a specific Dokka format. */ -@DokkaInternalApi +@InternalDokkaGradlePluginApi class FormatAttributes( formatName: String, ) { diff --git a/dokka-runners/dokka-gradle-plugin/src/main/kotlin/engine/parameters/DokkaExternalDocumentationLinkSpec.kt b/dokka-runners/dokka-gradle-plugin/src/main/kotlin/engine/parameters/DokkaExternalDocumentationLinkSpec.kt index 084081c688..71cec1a14b 100644 --- a/dokka-runners/dokka-gradle-plugin/src/main/kotlin/engine/parameters/DokkaExternalDocumentationLinkSpec.kt +++ b/dokka-runners/dokka-gradle-plugin/src/main/kotlin/engine/parameters/DokkaExternalDocumentationLinkSpec.kt @@ -9,7 +9,7 @@ import org.gradle.api.provider.Provider import org.gradle.api.tasks.Input import org.gradle.api.tasks.Internal import org.intellij.lang.annotations.Language -import org.jetbrains.dokka.gradle.internal.DokkaInternalApi +import org.jetbrains.dokka.gradle.internal.InternalDokkaGradlePluginApi import java.io.Serializable import java.net.URI import javax.inject.Inject @@ -37,7 +37,7 @@ import javax.inject.Inject * ``` */ abstract class DokkaExternalDocumentationLinkSpec -@DokkaInternalApi +@InternalDokkaGradlePluginApi @Inject constructor( private val name: String diff --git a/dokka-runners/dokka-gradle-plugin/src/main/kotlin/engine/parameters/DokkaGeneratorParametersSpec.kt b/dokka-runners/dokka-gradle-plugin/src/main/kotlin/engine/parameters/DokkaGeneratorParametersSpec.kt index 3c8f43db99..7578f1ff87 100644 --- a/dokka-runners/dokka-gradle-plugin/src/main/kotlin/engine/parameters/DokkaGeneratorParametersSpec.kt +++ b/dokka-runners/dokka-gradle-plugin/src/main/kotlin/engine/parameters/DokkaGeneratorParametersSpec.kt @@ -10,7 +10,7 @@ import org.gradle.api.plugins.ExtensionAware import org.gradle.api.provider.Property import org.gradle.api.tasks.* import org.gradle.api.tasks.PathSensitivity.RELATIVE -import org.jetbrains.dokka.gradle.internal.DokkaInternalApi +import org.jetbrains.dokka.gradle.internal.InternalDokkaGradlePluginApi import org.jetbrains.dokka.gradle.internal.DokkaPluginParametersContainer import org.jetbrains.dokka.gradle.internal.adding import org.jetbrains.dokka.gradle.internal.domainObjectContainer @@ -27,7 +27,7 @@ import javax.inject.Inject * [DokkaSourceSetSpec] and [org.jetbrains.dokka.gradle.formats.DokkaPublication]. */ abstract class DokkaGeneratorParametersSpec -@DokkaInternalApi +@InternalDokkaGradlePluginApi @Inject constructor( objects: ObjectFactory, diff --git a/dokka-runners/dokka-gradle-plugin/src/main/kotlin/engine/parameters/DokkaModuleDescriptionKxs.kt b/dokka-runners/dokka-gradle-plugin/src/main/kotlin/engine/parameters/DokkaModuleDescriptionKxs.kt index 71828b4db1..174b550943 100644 --- a/dokka-runners/dokka-gradle-plugin/src/main/kotlin/engine/parameters/DokkaModuleDescriptionKxs.kt +++ b/dokka-runners/dokka-gradle-plugin/src/main/kotlin/engine/parameters/DokkaModuleDescriptionKxs.kt @@ -6,7 +6,7 @@ package org.jetbrains.dokka.gradle.engine.parameters import kotlinx.serialization.Serializable import org.gradle.kotlin.dsl.java import org.jetbrains.dokka.DokkaConfiguration -import org.jetbrains.dokka.gradle.internal.DokkaInternalApi +import org.jetbrains.dokka.gradle.internal.InternalDokkaGradlePluginApi /** * Any subproject can be merged into a single Dokka Publication. To do this, first it must create @@ -24,7 +24,7 @@ import org.jetbrains.dokka.gradle.internal.DokkaInternalApi * @see org.jetbrains.dokka.DokkaModuleDescriptionImpl */ @Serializable -@DokkaInternalApi +@InternalDokkaGradlePluginApi data class DokkaModuleDescriptionKxs( /** @see DokkaConfiguration.DokkaModuleDescription.name */ val name: String, diff --git a/dokka-runners/dokka-gradle-plugin/src/main/kotlin/engine/parameters/DokkaPackageOptionsSpec.kt b/dokka-runners/dokka-gradle-plugin/src/main/kotlin/engine/parameters/DokkaPackageOptionsSpec.kt index 91239c562f..248545543d 100644 --- a/dokka-runners/dokka-gradle-plugin/src/main/kotlin/engine/parameters/DokkaPackageOptionsSpec.kt +++ b/dokka-runners/dokka-gradle-plugin/src/main/kotlin/engine/parameters/DokkaPackageOptionsSpec.kt @@ -6,7 +6,7 @@ package org.jetbrains.dokka.gradle.engine.parameters import org.gradle.api.provider.Property import org.gradle.api.provider.SetProperty import org.gradle.api.tasks.Input -import org.jetbrains.dokka.gradle.internal.DokkaInternalApi +import org.jetbrains.dokka.gradle.internal.InternalDokkaGradlePluginApi import java.io.Serializable /** @@ -28,7 +28,7 @@ import java.io.Serializable * ``` */ abstract class DokkaPackageOptionsSpec -@DokkaInternalApi +@InternalDokkaGradlePluginApi constructor() : HasConfigurableVisibilityModifiers, Serializable { diff --git a/dokka-runners/dokka-gradle-plugin/src/main/kotlin/engine/parameters/DokkaSourceLinkSpec.kt b/dokka-runners/dokka-gradle-plugin/src/main/kotlin/engine/parameters/DokkaSourceLinkSpec.kt index 2ab748e50d..91a5f893a7 100644 --- a/dokka-runners/dokka-gradle-plugin/src/main/kotlin/engine/parameters/DokkaSourceLinkSpec.kt +++ b/dokka-runners/dokka-gradle-plugin/src/main/kotlin/engine/parameters/DokkaSourceLinkSpec.kt @@ -11,7 +11,7 @@ import org.gradle.api.tasks.Input import org.gradle.api.tasks.Internal import org.gradle.api.tasks.Optional import org.intellij.lang.annotations.Language -import org.jetbrains.dokka.gradle.internal.DokkaInternalApi +import org.jetbrains.dokka.gradle.internal.InternalDokkaGradlePluginApi import java.io.Serializable import java.net.URI import javax.inject.Inject @@ -32,7 +32,7 @@ import javax.inject.Inject * ``` */ abstract class DokkaSourceLinkSpec -@DokkaInternalApi +@InternalDokkaGradlePluginApi @Inject constructor( private val layout: ProjectLayout @@ -61,7 +61,7 @@ constructor( * Should not be used anywhere directly. */ @get:Input - @DokkaInternalApi + @InternalDokkaGradlePluginApi internal val localDirectoryPath: Provider get() = localDirectory.map { it.asFile.relativeTo(layout.projectDirectory.asFile).invariantSeparatorsPath diff --git a/dokka-runners/dokka-gradle-plugin/src/main/kotlin/engine/parameters/DokkaSourceSetSpec.kt b/dokka-runners/dokka-gradle-plugin/src/main/kotlin/engine/parameters/DokkaSourceSetSpec.kt index 0345f85f15..6e2d18c0e2 100644 --- a/dokka-runners/dokka-gradle-plugin/src/main/kotlin/engine/parameters/DokkaSourceSetSpec.kt +++ b/dokka-runners/dokka-gradle-plugin/src/main/kotlin/engine/parameters/DokkaSourceSetSpec.kt @@ -17,7 +17,7 @@ import org.gradle.api.tasks.* import org.gradle.kotlin.dsl.java import org.gradle.kotlin.dsl.newInstance import org.jetbrains.dokka.gradle.engine.parameters.SourceSetIdSpec.Companion.dokkaSourceSetIdSpec -import org.jetbrains.dokka.gradle.internal.DokkaInternalApi +import org.jetbrains.dokka.gradle.internal.InternalDokkaGradlePluginApi import org.jetbrains.dokka.gradle.internal.adding import org.jetbrains.dokka.gradle.internal.domainObjectContainer import java.io.Serializable @@ -52,7 +52,7 @@ import kotlin.DeprecationLevel.ERROR * @see org.jetbrains.dokka.DokkaSourceSetImpl */ abstract class DokkaSourceSetSpec -@DokkaInternalApi +@InternalDokkaGradlePluginApi @Inject constructor( private val name: String, diff --git a/dokka-runners/dokka-gradle-plugin/src/main/kotlin/engine/parameters/SourceSetIdSpec.kt b/dokka-runners/dokka-gradle-plugin/src/main/kotlin/engine/parameters/SourceSetIdSpec.kt index 7061b64ef3..ac4e757930 100644 --- a/dokka-runners/dokka-gradle-plugin/src/main/kotlin/engine/parameters/SourceSetIdSpec.kt +++ b/dokka-runners/dokka-gradle-plugin/src/main/kotlin/engine/parameters/SourceSetIdSpec.kt @@ -8,7 +8,7 @@ import org.gradle.api.model.ObjectFactory import org.gradle.api.tasks.Input import org.gradle.api.tasks.Internal import org.gradle.kotlin.dsl.newInstance -import org.jetbrains.dokka.gradle.internal.DokkaInternalApi +import org.jetbrains.dokka.gradle.internal.InternalDokkaGradlePluginApi import java.io.Serializable import javax.inject.Inject @@ -20,7 +20,7 @@ import javax.inject.Inject * uniquely identified. */ abstract class SourceSetIdSpec -@DokkaInternalApi +@InternalDokkaGradlePluginApi @Inject constructor( /** @@ -55,7 +55,7 @@ constructor( companion object { /** Utility for creating a new [SourceSetIdSpec] instance using [ObjectFactory.newInstance] */ - @DokkaInternalApi + @InternalDokkaGradlePluginApi fun ObjectFactory.dokkaSourceSetIdSpec( scopeId: String, sourceSetName: String, diff --git a/dokka-runners/dokka-gradle-plugin/src/main/kotlin/engine/parameters/builders/DokkaParametersBuilder.kt b/dokka-runners/dokka-gradle-plugin/src/main/kotlin/engine/parameters/builders/DokkaParametersBuilder.kt index fb0f4a7062..0657666714 100644 --- a/dokka-runners/dokka-gradle-plugin/src/main/kotlin/engine/parameters/builders/DokkaParametersBuilder.kt +++ b/dokka-runners/dokka-gradle-plugin/src/main/kotlin/engine/parameters/builders/DokkaParametersBuilder.kt @@ -14,7 +14,7 @@ import org.jetbrains.dokka.gradle.engine.parameters.DokkaGeneratorParametersSpec import org.jetbrains.dokka.gradle.engine.parameters.DokkaModuleDescriptionKxs import org.jetbrains.dokka.gradle.engine.plugins.DokkaPluginParametersBaseSpec import org.jetbrains.dokka.gradle.formats.DokkaHtmlPlugin.Companion.extractDokkaPluginMarkers -import org.jetbrains.dokka.gradle.internal.DokkaInternalApi +import org.jetbrains.dokka.gradle.internal.InternalDokkaGradlePluginApi import java.io.File /** @@ -24,7 +24,7 @@ import java.io.File * The conversion is defined in a separate class to try and prevent classes from Dokka Generator * leaking into the public API. */ -@DokkaInternalApi +@InternalDokkaGradlePluginApi internal class DokkaParametersBuilder( private val archives: ArchiveOperations, ) { diff --git a/dokka-runners/dokka-gradle-plugin/src/main/kotlin/engine/parameters/builders/DokkaSourceSetBuilder.kt b/dokka-runners/dokka-gradle-plugin/src/main/kotlin/engine/parameters/builders/DokkaSourceSetBuilder.kt index 7216b87131..b70448b331 100644 --- a/dokka-runners/dokka-gradle-plugin/src/main/kotlin/engine/parameters/builders/DokkaSourceSetBuilder.kt +++ b/dokka-runners/dokka-gradle-plugin/src/main/kotlin/engine/parameters/builders/DokkaSourceSetBuilder.kt @@ -8,7 +8,7 @@ import org.jetbrains.dokka.* import org.jetbrains.dokka.gradle.engine.parameters.* import org.jetbrains.dokka.gradle.engine.parameters.KotlinPlatform.Companion.dokkaType import org.jetbrains.dokka.gradle.engine.parameters.VisibilityModifier.Companion.dokkaType -import org.jetbrains.dokka.gradle.internal.DokkaInternalApi +import org.jetbrains.dokka.gradle.internal.InternalDokkaGradlePluginApi import org.jetbrains.dokka.gradle.internal.mapNotNullToSet import org.jetbrains.dokka.gradle.internal.mapToSet @@ -19,7 +19,7 @@ import org.jetbrains.dokka.gradle.internal.mapToSet * The conversion is defined in a separate class to try and prevent classes from Dokka Generator * leaking into the public API. */ -@DokkaInternalApi +@InternalDokkaGradlePluginApi internal object DokkaSourceSetBuilder { private val logger = Logging.getLogger(DokkaParametersBuilder::class.java) diff --git a/dokka-runners/dokka-gradle-plugin/src/main/kotlin/engine/plugins/DokkaHtmlPluginParameters.kt b/dokka-runners/dokka-gradle-plugin/src/main/kotlin/engine/plugins/DokkaHtmlPluginParameters.kt index 228803d0c1..97f7cf21a3 100644 --- a/dokka-runners/dokka-gradle-plugin/src/main/kotlin/engine/plugins/DokkaHtmlPluginParameters.kt +++ b/dokka-runners/dokka-gradle-plugin/src/main/kotlin/engine/plugins/DokkaHtmlPluginParameters.kt @@ -10,7 +10,7 @@ import org.gradle.api.file.DirectoryProperty import org.gradle.api.provider.Property import org.gradle.api.tasks.* import org.gradle.api.tasks.PathSensitivity.RELATIVE -import org.jetbrains.dokka.gradle.internal.DokkaInternalApi +import org.jetbrains.dokka.gradle.internal.InternalDokkaGradlePluginApi import org.jetbrains.dokka.gradle.internal.addAll import org.jetbrains.dokka.gradle.internal.putIfNotNull import javax.inject.Inject @@ -22,7 +22,7 @@ import javax.inject.Inject * [More information is available in the Dokka docs.](https://kotlinlang.org/docs/dokka-html.html#configuration) */ abstract class DokkaHtmlPluginParameters -@DokkaInternalApi +@InternalDokkaGradlePluginApi @Inject constructor( name: String diff --git a/dokka-runners/dokka-gradle-plugin/src/main/kotlin/engine/plugins/DokkaPluginParametersBaseSpec.kt b/dokka-runners/dokka-gradle-plugin/src/main/kotlin/engine/plugins/DokkaPluginParametersBaseSpec.kt index b6d94d14c4..3b9b857a1d 100644 --- a/dokka-runners/dokka-gradle-plugin/src/main/kotlin/engine/plugins/DokkaPluginParametersBaseSpec.kt +++ b/dokka-runners/dokka-gradle-plugin/src/main/kotlin/engine/plugins/DokkaPluginParametersBaseSpec.kt @@ -5,7 +5,7 @@ package org.jetbrains.dokka.gradle.engine.plugins import org.gradle.api.Named import org.gradle.api.tasks.Input -import org.jetbrains.dokka.gradle.internal.DokkaInternalApi +import org.jetbrains.dokka.gradle.internal.InternalDokkaGradlePluginApi import java.io.Serializable import javax.inject.Inject @@ -20,7 +20,7 @@ import javax.inject.Inject * @param[pluginFqn] Fully qualified classname of the Dokka Plugin */ abstract class DokkaPluginParametersBaseSpec -@DokkaInternalApi +@InternalDokkaGradlePluginApi @Inject constructor( private val name: String, diff --git a/dokka-runners/dokka-gradle-plugin/src/main/kotlin/engine/plugins/DokkaPluginParametersBuilder.kt b/dokka-runners/dokka-gradle-plugin/src/main/kotlin/engine/plugins/DokkaPluginParametersBuilder.kt index 9a6c933e3f..5e863bf0a9 100644 --- a/dokka-runners/dokka-gradle-plugin/src/main/kotlin/engine/plugins/DokkaPluginParametersBuilder.kt +++ b/dokka-runners/dokka-gradle-plugin/src/main/kotlin/engine/plugins/DokkaPluginParametersBuilder.kt @@ -19,7 +19,7 @@ import org.gradle.api.tasks.PathSensitivity.RELATIVE import org.gradle.kotlin.dsl.containerWithType import org.gradle.kotlin.dsl.listProperty import org.gradle.kotlin.dsl.mapProperty -import org.jetbrains.dokka.gradle.internal.DokkaInternalApi +import org.jetbrains.dokka.gradle.internal.InternalDokkaGradlePluginApi import org.jetbrains.dokka.gradle.internal.DokkaPluginParametersContainer import java.io.File import javax.inject.Inject @@ -53,7 +53,7 @@ fun DokkaPluginParametersContainer.pluginParameters( */ abstract class DokkaPluginParametersBuilder @Inject -@DokkaInternalApi +@InternalDokkaGradlePluginApi constructor( name: String, @get:Input diff --git a/dokka-runners/dokka-gradle-plugin/src/main/kotlin/engine/plugins/DokkaVersioningPluginParameters.kt b/dokka-runners/dokka-gradle-plugin/src/main/kotlin/engine/plugins/DokkaVersioningPluginParameters.kt index 951950cf83..2b3ee9ddbe 100644 --- a/dokka-runners/dokka-gradle-plugin/src/main/kotlin/engine/plugins/DokkaVersioningPluginParameters.kt +++ b/dokka-runners/dokka-gradle-plugin/src/main/kotlin/engine/plugins/DokkaVersioningPluginParameters.kt @@ -11,7 +11,7 @@ import org.gradle.api.provider.ListProperty import org.gradle.api.provider.Property import org.gradle.api.tasks.* import org.gradle.api.tasks.PathSensitivity.RELATIVE -import org.jetbrains.dokka.gradle.internal.DokkaInternalApi +import org.jetbrains.dokka.gradle.internal.InternalDokkaGradlePluginApi import org.jetbrains.dokka.gradle.internal.addAll import org.jetbrains.dokka.gradle.internal.putIfNotNull import javax.inject.Inject @@ -28,7 +28,7 @@ import javax.inject.Inject * Note: The versioning plugin only works with Dokka's HTML format. */ abstract class DokkaVersioningPluginParameters -@DokkaInternalApi +@InternalDokkaGradlePluginApi @Inject constructor( name: String, diff --git a/dokka-runners/dokka-gradle-plugin/src/main/kotlin/formats/DokkaFormatPlugin.kt b/dokka-runners/dokka-gradle-plugin/src/main/kotlin/formats/DokkaFormatPlugin.kt index 36825645df..8b71003f4b 100644 --- a/dokka-runners/dokka-gradle-plugin/src/main/kotlin/formats/DokkaFormatPlugin.kt +++ b/dokka-runners/dokka-gradle-plugin/src/main/kotlin/formats/DokkaFormatPlugin.kt @@ -27,7 +27,7 @@ import org.jetbrains.dokka.gradle.dependencies.DependencyContainerNames import org.jetbrains.dokka.gradle.dependencies.DokkaAttribute.Companion.DokkaClasspathAttribute import org.jetbrains.dokka.gradle.dependencies.DokkaAttribute.Companion.DokkaFormatAttribute import org.jetbrains.dokka.gradle.dependencies.FormatDependenciesManager -import org.jetbrains.dokka.gradle.internal.DokkaInternalApi +import org.jetbrains.dokka.gradle.internal.InternalDokkaGradlePluginApi import org.jetbrains.dokka.gradle.internal.PluginFeaturesService.Companion.pluginFeaturesService import javax.inject.Inject @@ -43,19 +43,19 @@ abstract class DokkaFormatPlugin( ) : Plugin { @get:Inject - @DokkaInternalApi + @InternalDokkaGradlePluginApi protected abstract val objects: ObjectFactory @get:Inject - @DokkaInternalApi + @InternalDokkaGradlePluginApi protected abstract val providers: ProviderFactory @get:Inject - @DokkaInternalApi + @InternalDokkaGradlePluginApi protected abstract val files: FileSystemOperations @get:Inject - @DokkaInternalApi + @InternalDokkaGradlePluginApi protected abstract val layout: ProjectLayout @@ -148,7 +148,7 @@ abstract class DokkaFormatPlugin( open fun DokkaFormatPluginContext.configure() {} - @DokkaInternalApi + @InternalDokkaGradlePluginApi class DokkaFormatPluginContext( val project: Project, val dokkaExtension: DokkaExtension, diff --git a/dokka-runners/dokka-gradle-plugin/src/main/kotlin/formats/DokkaFormatTasks.kt b/dokka-runners/dokka-gradle-plugin/src/main/kotlin/formats/DokkaFormatTasks.kt index cfd3473602..fd30f490a8 100644 --- a/dokka-runners/dokka-gradle-plugin/src/main/kotlin/formats/DokkaFormatTasks.kt +++ b/dokka-runners/dokka-gradle-plugin/src/main/kotlin/formats/DokkaFormatTasks.kt @@ -8,7 +8,7 @@ import org.gradle.api.provider.ProviderFactory import org.gradle.api.tasks.TaskProvider import org.gradle.kotlin.dsl.register import org.jetbrains.dokka.gradle.dependencies.FormatDependenciesManager -import org.jetbrains.dokka.gradle.internal.DokkaInternalApi +import org.jetbrains.dokka.gradle.internal.InternalDokkaGradlePluginApi import org.jetbrains.dokka.gradle.internal.configuring import org.jetbrains.dokka.gradle.tasks.DokkaGenerateModuleTask import org.jetbrains.dokka.gradle.tasks.DokkaGeneratePublicationTask @@ -16,7 +16,7 @@ import org.jetbrains.dokka.gradle.tasks.DokkaGenerateTask import org.jetbrains.dokka.gradle.tasks.TaskNames /** Tasks for generating a [DokkaPublication] in a specific format. */ -@DokkaInternalApi +@InternalDokkaGradlePluginApi class DokkaFormatTasks( project: Project, private val publication: DokkaPublication, diff --git a/dokka-runners/dokka-gradle-plugin/src/main/kotlin/formats/DokkaHtmlPlugin.kt b/dokka-runners/dokka-gradle-plugin/src/main/kotlin/formats/DokkaHtmlPlugin.kt index ec4cda1ca6..8627e4a52c 100644 --- a/dokka-runners/dokka-gradle-plugin/src/main/kotlin/formats/DokkaHtmlPlugin.kt +++ b/dokka-runners/dokka-gradle-plugin/src/main/kotlin/formats/DokkaHtmlPlugin.kt @@ -15,7 +15,7 @@ import org.jetbrains.dokka.gradle.engine.plugins.DokkaHtmlPluginParameters import org.jetbrains.dokka.gradle.engine.plugins.DokkaHtmlPluginParameters.Companion.DOKKA_HTML_PARAMETERS_NAME import org.jetbrains.dokka.gradle.engine.plugins.DokkaVersioningPluginParameters import org.jetbrains.dokka.gradle.engine.plugins.DokkaVersioningPluginParameters.Companion.DOKKA_VERSIONING_PLUGIN_PARAMETERS_NAME -import org.jetbrains.dokka.gradle.internal.DokkaInternalApi +import org.jetbrains.dokka.gradle.internal.InternalDokkaGradlePluginApi import org.jetbrains.dokka.gradle.internal.rootProjectName import org.jetbrains.dokka.gradle.internal.uppercaseFirstChar import org.jetbrains.dokka.gradle.tasks.DokkaGeneratePublicationTask @@ -24,7 +24,7 @@ import java.io.File import javax.inject.Inject abstract class DokkaHtmlPlugin -@DokkaInternalApi +@InternalDokkaGradlePluginApi @Inject constructor( archives: ArchiveOperations, @@ -178,7 +178,7 @@ constructor( } } - @DokkaInternalApi + @InternalDokkaGradlePluginApi companion object { private val logger = Logging.getLogger(DokkaHtmlPlugin::class.java) diff --git a/dokka-runners/dokka-gradle-plugin/src/main/kotlin/formats/DokkaJavadocPlugin.kt b/dokka-runners/dokka-gradle-plugin/src/main/kotlin/formats/DokkaJavadocPlugin.kt index e97d1cdfad..6c17c8e18a 100644 --- a/dokka-runners/dokka-gradle-plugin/src/main/kotlin/formats/DokkaJavadocPlugin.kt +++ b/dokka-runners/dokka-gradle-plugin/src/main/kotlin/formats/DokkaJavadocPlugin.kt @@ -4,13 +4,13 @@ package org.jetbrains.dokka.gradle.formats import org.gradle.kotlin.dsl.dependencies -import org.jetbrains.dokka.gradle.internal.DokkaInternalApi +import org.jetbrains.dokka.gradle.internal.InternalDokkaGradlePluginApi /** * Gradle plugin that configures Dokka Javadoc output format */ abstract class DokkaJavadocPlugin -@DokkaInternalApi +@InternalDokkaGradlePluginApi constructor() : DokkaFormatPlugin(formatName = "javadoc") { override fun DokkaFormatPluginContext.configure() { project.dependencies { diff --git a/dokka-runners/dokka-gradle-plugin/src/main/kotlin/formats/DokkaPublication.kt b/dokka-runners/dokka-gradle-plugin/src/main/kotlin/formats/DokkaPublication.kt index 475472af14..34bfdb89df 100644 --- a/dokka-runners/dokka-gradle-plugin/src/main/kotlin/formats/DokkaPublication.kt +++ b/dokka-runners/dokka-gradle-plugin/src/main/kotlin/formats/DokkaPublication.kt @@ -9,7 +9,7 @@ import org.gradle.api.file.DirectoryProperty import org.gradle.api.plugins.ExtensionAware import org.gradle.api.provider.Property import org.jetbrains.dokka.gradle.engine.parameters.DokkaSourceSetSpec -import org.jetbrains.dokka.gradle.internal.DokkaInternalApi +import org.jetbrains.dokka.gradle.internal.InternalDokkaGradlePluginApi import org.jetbrains.dokka.gradle.internal.DokkaPluginParametersContainer import org.jetbrains.dokka.gradle.internal.adding import java.io.Serializable @@ -23,7 +23,7 @@ import javax.inject.Inject * Each Dokka Publication has its own set of Gradle tasks and [org.gradle.api.artifacts.Configuration]s. */ abstract class DokkaPublication -@DokkaInternalApi +@InternalDokkaGradlePluginApi @Inject constructor( /** diff --git a/dokka-runners/dokka-gradle-plugin/src/main/kotlin/internal/HasFormatName.kt b/dokka-runners/dokka-gradle-plugin/src/main/kotlin/internal/HasFormatName.kt index f32a21c3f1..76a8c4d8e1 100644 --- a/dokka-runners/dokka-gradle-plugin/src/main/kotlin/internal/HasFormatName.kt +++ b/dokka-runners/dokka-gradle-plugin/src/main/kotlin/internal/HasFormatName.kt @@ -6,7 +6,7 @@ package org.jetbrains.dokka.gradle.internal /** * The base type for types that specifically for a single Dokka output format (e.g. HTML or Javadoc). */ -@DokkaInternalApi +@InternalDokkaGradlePluginApi abstract class HasFormatName { abstract val formatName: String diff --git a/dokka-runners/dokka-gradle-plugin/src/main/kotlin/internal/DokkaInternalApi.kt b/dokka-runners/dokka-gradle-plugin/src/main/kotlin/internal/InternalDokkaGradlePluginApi.kt similarity index 96% rename from dokka-runners/dokka-gradle-plugin/src/main/kotlin/internal/DokkaInternalApi.kt rename to dokka-runners/dokka-gradle-plugin/src/main/kotlin/internal/InternalDokkaGradlePluginApi.kt index 9ce1016439..d7e7762ded 100644 --- a/dokka-runners/dokka-gradle-plugin/src/main/kotlin/internal/DokkaInternalApi.kt +++ b/dokka-runners/dokka-gradle-plugin/src/main/kotlin/internal/InternalDokkaGradlePluginApi.kt @@ -35,4 +35,4 @@ import kotlin.annotation.AnnotationTarget.* PROPERTY_GETTER, ) @MustBeDocumented -annotation class DokkaInternalApi +annotation class InternalDokkaGradlePluginApi diff --git a/dokka-runners/dokka-gradle-plugin/src/main/kotlin/internal/PluginFeaturesService.kt b/dokka-runners/dokka-gradle-plugin/src/main/kotlin/internal/PluginFeaturesService.kt index b64574d1d7..809403ce11 100644 --- a/dokka-runners/dokka-gradle-plugin/src/main/kotlin/internal/PluginFeaturesService.kt +++ b/dokka-runners/dokka-gradle-plugin/src/main/kotlin/internal/PluginFeaturesService.kt @@ -28,7 +28,7 @@ import javax.inject.Inject * regardless of how many subprojects have applied DGP. */ internal abstract class PluginFeaturesService -@DokkaInternalApi +@InternalDokkaGradlePluginApi @Inject constructor( providers: ProviderFactory, diff --git a/dokka-runners/dokka-gradle-plugin/src/main/kotlin/tasks/DokkaBaseTask.kt b/dokka-runners/dokka-gradle-plugin/src/main/kotlin/tasks/DokkaBaseTask.kt index 06ef3f05e6..1c20b8dac4 100644 --- a/dokka-runners/dokka-gradle-plugin/src/main/kotlin/tasks/DokkaBaseTask.kt +++ b/dokka-runners/dokka-gradle-plugin/src/main/kotlin/tasks/DokkaBaseTask.kt @@ -7,13 +7,13 @@ import org.gradle.api.DefaultTask import org.gradle.api.model.ObjectFactory import org.gradle.api.tasks.CacheableTask import org.jetbrains.dokka.gradle.DokkaBasePlugin -import org.jetbrains.dokka.gradle.internal.DokkaInternalApi +import org.jetbrains.dokka.gradle.internal.InternalDokkaGradlePluginApi import javax.inject.Inject /** Base Dokka task */ @CacheableTask abstract class DokkaBaseTask -@DokkaInternalApi +@InternalDokkaGradlePluginApi constructor() : DefaultTask() { @get:Inject diff --git a/dokka-runners/dokka-gradle-plugin/src/main/kotlin/tasks/DokkaGenerateModuleTask.kt b/dokka-runners/dokka-gradle-plugin/src/main/kotlin/tasks/DokkaGenerateModuleTask.kt index c06196b2cf..6341d014d1 100644 --- a/dokka-runners/dokka-gradle-plugin/src/main/kotlin/tasks/DokkaGenerateModuleTask.kt +++ b/dokka-runners/dokka-gradle-plugin/src/main/kotlin/tasks/DokkaGenerateModuleTask.kt @@ -14,7 +14,7 @@ import org.gradle.workers.WorkerExecutor import org.jetbrains.dokka.gradle.DokkaBasePlugin import org.jetbrains.dokka.gradle.engine.parameters.DokkaModuleDescriptionKxs import org.jetbrains.dokka.gradle.internal.DokkaPluginParametersContainer -import org.jetbrains.dokka.gradle.internal.DokkaInternalApi +import org.jetbrains.dokka.gradle.internal.InternalDokkaGradlePluginApi import java.io.File import javax.inject.Inject @@ -27,7 +27,7 @@ import javax.inject.Inject */ @CacheableTask abstract class DokkaGenerateModuleTask -@DokkaInternalApi +@InternalDokkaGradlePluginApi @Inject constructor( objects: ObjectFactory, diff --git a/dokka-runners/dokka-gradle-plugin/src/main/kotlin/tasks/DokkaGeneratePublicationTask.kt b/dokka-runners/dokka-gradle-plugin/src/main/kotlin/tasks/DokkaGeneratePublicationTask.kt index 537b916a4c..94d7761fc0 100644 --- a/dokka-runners/dokka-gradle-plugin/src/main/kotlin/tasks/DokkaGeneratePublicationTask.kt +++ b/dokka-runners/dokka-gradle-plugin/src/main/kotlin/tasks/DokkaGeneratePublicationTask.kt @@ -10,7 +10,7 @@ import org.gradle.api.tasks.CacheableTask import org.gradle.api.tasks.TaskAction import org.gradle.workers.WorkerExecutor import org.jetbrains.dokka.gradle.internal.DokkaPluginParametersContainer -import org.jetbrains.dokka.gradle.internal.DokkaInternalApi +import org.jetbrains.dokka.gradle.internal.InternalDokkaGradlePluginApi import javax.inject.Inject @@ -22,7 +22,7 @@ import javax.inject.Inject */ @CacheableTask abstract class DokkaGeneratePublicationTask -@DokkaInternalApi +@InternalDokkaGradlePluginApi @Inject constructor( objects: ObjectFactory, diff --git a/dokka-runners/dokka-gradle-plugin/src/main/kotlin/tasks/DokkaGenerateTask.kt b/dokka-runners/dokka-gradle-plugin/src/main/kotlin/tasks/DokkaGenerateTask.kt index 1cabf4ae0c..d78d629b35 100644 --- a/dokka-runners/dokka-gradle-plugin/src/main/kotlin/tasks/DokkaGenerateTask.kt +++ b/dokka-runners/dokka-gradle-plugin/src/main/kotlin/tasks/DokkaGenerateTask.kt @@ -18,7 +18,7 @@ import org.jetbrains.dokka.DokkaConfiguration import org.jetbrains.dokka.gradle.DokkaBasePlugin.Companion.jsonMapper import org.jetbrains.dokka.gradle.engine.parameters.DokkaGeneratorParametersSpec import org.jetbrains.dokka.gradle.engine.parameters.builders.DokkaParametersBuilder -import org.jetbrains.dokka.gradle.internal.DokkaInternalApi +import org.jetbrains.dokka.gradle.internal.InternalDokkaGradlePluginApi import org.jetbrains.dokka.gradle.internal.DokkaPluginParametersContainer import org.jetbrains.dokka.gradle.workers.ClassLoaderIsolation import org.jetbrains.dokka.gradle.workers.DokkaGeneratorWorker @@ -35,7 +35,7 @@ import javax.inject.Inject */ @CacheableTask abstract class DokkaGenerateTask -@DokkaInternalApi +@InternalDokkaGradlePluginApi @Inject constructor( objects: ObjectFactory, @@ -99,17 +99,17 @@ constructor( * The [DokkaConfiguration] by Dokka Generator can be saved to a file for debugging purposes. * To disable this behaviour set this property to `null`. */ - @DokkaInternalApi + @InternalDokkaGradlePluginApi @get:Internal abstract val dokkaConfigurationJsonFile: RegularFileProperty - @DokkaInternalApi + @InternalDokkaGradlePluginApi enum class GeneratorMode { Module, Publication, } - @DokkaInternalApi + @InternalDokkaGradlePluginApi protected fun generateDocumentation( generationType: GeneratorMode, outputDirectory: File, diff --git a/dokka-runners/dokka-gradle-plugin/src/main/kotlin/tasks/LogHtmlPublicationLinkTask.kt b/dokka-runners/dokka-gradle-plugin/src/main/kotlin/tasks/LogHtmlPublicationLinkTask.kt index 96b0b38663..3dd0479731 100644 --- a/dokka-runners/dokka-gradle-plugin/src/main/kotlin/tasks/LogHtmlPublicationLinkTask.kt +++ b/dokka-runners/dokka-gradle-plugin/src/main/kotlin/tasks/LogHtmlPublicationLinkTask.kt @@ -11,7 +11,7 @@ import org.gradle.api.tasks.Console import org.gradle.api.tasks.TaskAction import org.gradle.api.tasks.UntrackedTask import org.gradle.kotlin.dsl.of -import org.jetbrains.dokka.gradle.internal.DokkaInternalApi +import org.jetbrains.dokka.gradle.internal.InternalDokkaGradlePluginApi import org.jetbrains.dokka.gradle.internal.PluginFeaturesService.Companion.pluginFeaturesService import org.jetbrains.dokka.gradle.internal.appendPath import org.slf4j.LoggerFactory @@ -39,7 +39,7 @@ import javax.inject.Inject @UntrackedTask(because = "logging-only task") abstract class LogHtmlPublicationLinkTask @Inject -@DokkaInternalApi +@InternalDokkaGradlePluginApi constructor( providers: ProviderFactory ) : DokkaBaseTask() { diff --git a/dokka-runners/dokka-gradle-plugin/src/main/kotlin/tasks/TaskNames.kt b/dokka-runners/dokka-gradle-plugin/src/main/kotlin/tasks/TaskNames.kt index c7f9614f41..63f23c2980 100644 --- a/dokka-runners/dokka-gradle-plugin/src/main/kotlin/tasks/TaskNames.kt +++ b/dokka-runners/dokka-gradle-plugin/src/main/kotlin/tasks/TaskNames.kt @@ -3,13 +3,13 @@ */ package org.jetbrains.dokka.gradle.tasks -import org.jetbrains.dokka.gradle.internal.DokkaInternalApi +import org.jetbrains.dokka.gradle.internal.InternalDokkaGradlePluginApi import org.jetbrains.dokka.gradle.internal.HasFormatName /** * Gradle [Task][org.gradle.api.Task] Names for a specific Dokka output format. */ -@DokkaInternalApi +@InternalDokkaGradlePluginApi class TaskNames(override val formatName: String) : HasFormatName() { val generate = "dokkaGenerate".appendFormat() val generatePublication = "dokkaGeneratePublication".appendFormat() diff --git a/dokka-runners/dokka-gradle-plugin/src/main/kotlin/workers/DokkaGeneratorWorker.kt b/dokka-runners/dokka-gradle-plugin/src/main/kotlin/workers/DokkaGeneratorWorker.kt index bbf605563c..4c62c6de8c 100644 --- a/dokka-runners/dokka-gradle-plugin/src/main/kotlin/workers/DokkaGeneratorWorker.kt +++ b/dokka-runners/dokka-gradle-plugin/src/main/kotlin/workers/DokkaGeneratorWorker.kt @@ -9,7 +9,7 @@ import org.gradle.workers.WorkAction import org.gradle.workers.WorkParameters import org.jetbrains.dokka.DokkaConfiguration import org.jetbrains.dokka.DokkaGenerator -import org.jetbrains.dokka.gradle.internal.DokkaInternalApi +import org.jetbrains.dokka.gradle.internal.InternalDokkaGradlePluginApi import org.jetbrains.dokka.gradle.internal.LoggerAdapter import java.io.File import java.time.Duration @@ -20,10 +20,10 @@ import java.time.Duration * The worker requires [DokkaGenerator] is present on its classpath, as well as any Dokka plugins * that are used to generate the Dokka files. Transitive dependencies are also required. */ -@DokkaInternalApi +@InternalDokkaGradlePluginApi abstract class DokkaGeneratorWorker : WorkAction { - @DokkaInternalApi + @InternalDokkaGradlePluginApi interface Parameters : WorkParameters { val dokkaParameters: Property val logFile: RegularFileProperty @@ -67,7 +67,7 @@ abstract class DokkaGeneratorWorker : WorkAction