diff options
Diffstat (limited to 'runners')
-rw-r--r-- | runners/cli/src/main/kotlin/org/jetbrains/dokka/main.kt (renamed from runners/cli/src/main/kotlin/cli/main.kt) | 1 | ||||
-rw-r--r-- | runners/cli/src/test/kotlin/org/jetbrains/dokka/CliTest.kt (renamed from runners/cli/src/test/kotlin/cli/CliTest.kt) | 2 | ||||
-rw-r--r-- | runners/gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/GradleDokkaSourceSetBuilder.kt | 10 | ||||
-rw-r--r-- | runners/gradle-plugin/src/test/kotlin/org/jetbrains/dokka/gradle/DokkaMultiModuleTaskTest.kt | 2 | ||||
-rw-r--r-- | runners/gradle-plugin/src/test/kotlin/org/jetbrains/dokka/gradle/GradleDokkaSourceSetBuilderTest.kt | 1 | ||||
-rw-r--r-- | runners/maven-plugin/src/main/kotlin/DokkaMojo.kt | 2 |
6 files changed, 13 insertions, 5 deletions
diff --git a/runners/cli/src/main/kotlin/cli/main.kt b/runners/cli/src/main/kotlin/org/jetbrains/dokka/main.kt index c2a68d68..aca57f7e 100644 --- a/runners/cli/src/main/kotlin/cli/main.kt +++ b/runners/cli/src/main/kotlin/org/jetbrains/dokka/main.kt @@ -281,6 +281,7 @@ private fun parseSourceSet(moduleName: String, args: Array<String>): DokkaConfig .toMutableSet() override val samples = samples.toMutableSet() override val includes = includes.toMutableSet() + @Deprecated("Use [documentedVisibilities] property for a more flexible control over documented visibilities") override val includeNonPublic = includeNonPublic override val reportUndocumented = reportUndocumented override val skipEmptyPackages = skipEmptyPackages diff --git a/runners/cli/src/test/kotlin/cli/CliTest.kt b/runners/cli/src/test/kotlin/org/jetbrains/dokka/CliTest.kt index 967003dc..557fe36b 100644 --- a/runners/cli/src/test/kotlin/cli/CliTest.kt +++ b/runners/cli/src/test/kotlin/org/jetbrains/dokka/CliTest.kt @@ -1,10 +1,10 @@ package org.jetbrains.dokka -import junit.framework.Assert.assertTrue import org.junit.Test import java.lang.IllegalStateException import java.nio.file.Paths import kotlin.test.assertEquals +import kotlin.test.assertTrue class CliIntegrationTest { diff --git a/runners/gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/GradleDokkaSourceSetBuilder.kt b/runners/gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/GradleDokkaSourceSetBuilder.kt index abaa2536..21f0e268 100644 --- a/runners/gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/GradleDokkaSourceSetBuilder.kt +++ b/runners/gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/GradleDokkaSourceSetBuilder.kt @@ -11,7 +11,6 @@ import org.gradle.api.provider.SetProperty import org.gradle.api.tasks.* import org.gradle.kotlin.dsl.listProperty import org.gradle.kotlin.dsl.setProperty -import org.gradle.util.ConfigureUtil import org.jetbrains.dokka.* import java.io.File import java.net.URL @@ -156,8 +155,9 @@ open class GradleDokkaSourceSetBuilder( sourceRoot(project.file(path)) } + @Suppress("DEPRECATION") // TODO [beresnev] ConfigureUtil will be removed in Gradle 8 fun sourceLink(c: Closure<in GradleSourceLinkBuilder>) { - val configured = ConfigureUtil.configure(c, GradleSourceLinkBuilder(project)) + val configured = org.gradle.util.ConfigureUtil.configure(c, GradleSourceLinkBuilder(project)) sourceLinks.add(configured) } @@ -167,8 +167,9 @@ open class GradleDokkaSourceSetBuilder( sourceLinks.add(sourceLink) } + @Suppress("DEPRECATION") // TODO [beresnev] ConfigureUtil will be removed in Gradle 8 fun perPackageOption(c: Closure<in GradlePackageOptionsBuilder>) { - val configured = ConfigureUtil.configure(c, GradlePackageOptionsBuilder(project)) + val configured = org.gradle.util.ConfigureUtil.configure(c, GradlePackageOptionsBuilder(project)) perPackageOptions.add(configured) } @@ -178,8 +179,9 @@ open class GradleDokkaSourceSetBuilder( perPackageOptions.add(option) } + @Suppress("DEPRECATION") // TODO [beresnev] ConfigureUtil will be removed in Gradle 8 fun externalDocumentationLink(c: Closure<in GradleExternalDocumentationLinkBuilder>) { - val link = ConfigureUtil.configure(c, GradleExternalDocumentationLinkBuilder(project)) + val link = org.gradle.util.ConfigureUtil.configure(c, GradleExternalDocumentationLinkBuilder(project)) externalDocumentationLinks.add(link) } diff --git a/runners/gradle-plugin/src/test/kotlin/org/jetbrains/dokka/gradle/DokkaMultiModuleTaskTest.kt b/runners/gradle-plugin/src/test/kotlin/org/jetbrains/dokka/gradle/DokkaMultiModuleTaskTest.kt index 5ad33c57..6e851326 100644 --- a/runners/gradle-plugin/src/test/kotlin/org/jetbrains/dokka/gradle/DokkaMultiModuleTaskTest.kt +++ b/runners/gradle-plugin/src/test/kotlin/org/jetbrains/dokka/gradle/DokkaMultiModuleTaskTest.kt @@ -201,6 +201,8 @@ class DokkaMultiModuleTaskTest { val childTask = child.tasks.create<DokkaTask>("child") parentTask.addChildTask(childTask) + + @Suppress("NAME_SHADOWING") // ¯\_(ツ)_/¯ parentTask.fileLayout by DokkaMultiModuleFileLayout { parent, child -> parent.project.buildDir.resolve(child.name) } diff --git a/runners/gradle-plugin/src/test/kotlin/org/jetbrains/dokka/gradle/GradleDokkaSourceSetBuilderTest.kt b/runners/gradle-plugin/src/test/kotlin/org/jetbrains/dokka/gradle/GradleDokkaSourceSetBuilderTest.kt index 59b35917..770d1af3 100644 --- a/runners/gradle-plugin/src/test/kotlin/org/jetbrains/dokka/gradle/GradleDokkaSourceSetBuilderTest.kt +++ b/runners/gradle-plugin/src/test/kotlin/org/jetbrains/dokka/gradle/GradleDokkaSourceSetBuilderTest.kt @@ -148,6 +148,7 @@ class GradleDokkaSourceSetBuilderTest { } @Test + @Suppress("DEPRECATION") fun includeNonPublic() { val sourceSet = GradleDokkaSourceSetBuilder("", project) assertEquals( diff --git a/runners/maven-plugin/src/main/kotlin/DokkaMojo.kt b/runners/maven-plugin/src/main/kotlin/DokkaMojo.kt index de190db1..94eacdb5 100644 --- a/runners/maven-plugin/src/main/kotlin/DokkaMojo.kt +++ b/runners/maven-plugin/src/main/kotlin/DokkaMojo.kt @@ -68,6 +68,7 @@ abstract class AbstractDokkaMojo(private val defaultDokkaPlugins: List<Dependenc override var matchingRegex: String = ".*" @Parameter + @Deprecated("Use [documentedVisibilities] property for a more flexible control over documented visibilities") override var includeNonPublic: Boolean = DokkaDefaults.includeNonPublic @Parameter @@ -214,6 +215,7 @@ abstract class AbstractDokkaMojo(private val defaultDokkaPlugins: List<Dependenc jdkVersion = jdkVersion, sourceLinks = sourceLinks.map { SourceLinkDefinitionImpl(it.path, URL(it.url), it.lineSuffix) }.toSet(), perPackageOptions = perPackageOptions.map { + @Suppress("DEPRECATION") // for includeNonPublic, preserve backwards compatibility PackageOptionsImpl( matchingRegex = it.matchingRegex, includeNonPublic = it.includeNonPublic, |