remove unnecessary FunctionName suppressions, or move to targeted loc…

…ation (not file-wide)
Kotlin · Apr 23, 2023 · 31fc16a · 31fc16a
1 parent ca45dbd
commit 31fc16a
Show file tree

Hide file tree

Showing 12 changed files with 23 additions and 37 deletions.
diff --git a/core/src/main/kotlin/configuration.kt b/core/src/main/kotlin/configuration.kt
@@ -1,5 +1,3 @@
-@file:Suppress("FunctionName")
-
 package org.jetbrains.dokka
 
 import org.jetbrains.dokka.utilities.cast
@@ -108,11 +106,13 @@ data class GlobalDokkaConfiguration(
 
 fun DokkaConfiguration.apply(globals: GlobalDokkaConfiguration): DokkaConfiguration = this.apply {
     sourceSets.forEach {
-        it.perPackageOptions.cast<MutableList<DokkaConfiguration.PackageOptions>>().addAll(globals.perPackageOptions ?: emptyList())
+        it.perPackageOptions.cast<MutableList<DokkaConfiguration.PackageOptions>>()
+            .addAll(globals.perPackageOptions ?: emptyList())
     }
 
     sourceSets.forEach {
-        it.externalDocumentationLinks.cast<MutableSet<DokkaConfiguration.ExternalDocumentationLink>>().addAll(globals.externalDocumentationLinks ?: emptyList())
+        it.externalDocumentationLinks.cast<MutableSet<DokkaConfiguration.ExternalDocumentationLink>>()
+            .addAll(globals.externalDocumentationLinks ?: emptyList())
     }
 
     sourceSets.forEach {
@@ -173,6 +173,7 @@ interface DokkaConfiguration : Serializable {
         val dependentSourceSets: Set<DokkaSourceSetID>
         val samples: Set<File>
         val includes: Set<File>
+
         @Deprecated(message = "Use [documentedVisibilities] property for a more flexible control over documented visibilities")
         val includeNonPublic: Boolean
         val reportUndocumented: Boolean
@@ -237,6 +238,7 @@ interface DokkaConfiguration : Serializable {
 
     interface PackageOptions : Serializable {
         val matchingRegex: String
+
         @Deprecated("Use [documentedVisibilities] property for a more flexible control over documented visibilities")
         val includeNonPublic: Boolean
         val reportUndocumented: Boolean?
@@ -253,6 +255,7 @@ interface DokkaConfiguration : Serializable {
     }
 }
 
+@Suppress("FunctionName")
 fun ExternalDocumentationLink(
     url: URL? = null,
     packageListUrl: URL? = null
@@ -265,10 +268,8 @@ fun ExternalDocumentationLink(
         throw IllegalArgumentException("url or url && packageListUrl must not be null for external documentation link")
 }
 
-
+@Suppress("FunctionName")
 fun ExternalDocumentationLink(
     url: String, packageListUrl: String? = null
 ): ExternalDocumentationLinkImpl =
     ExternalDocumentationLink(url.let(::URL), packageListUrl?.let(::URL))
-
-
diff --git a/core/src/main/kotlin/defaultExternalLinks.kt b/core/src/main/kotlin/defaultExternalLinks.kt
@@ -27,4 +27,3 @@ fun ExternalDocumentationLink.Companion.androidX(): ExternalDocumentationLinkImp
     url = URL("https://developer.android.com/reference/kotlin/"),
     packageListUrl = URL("https://developer.android.com/reference/kotlin/androidx/package-list")
 )
-
diff --git a/...ests/gradle/src/integrationTest/kotlin/org/jetbrains/dokka/it/gradle/ConfigurationTest.kt b/...ests/gradle/src/integrationTest/kotlin/org/jetbrains/dokka/it/gradle/ConfigurationTest.kt
@@ -1,5 +1,3 @@
-@file:Suppress("FunctionName")
-
 package org.jetbrains.dokka.it.gradle
 
 import org.gradle.testkit.runner.TaskOutcome
@@ -43,6 +41,7 @@ class ConfigurationTest(override val versions: BuildVersions) : AbstractGradleIn
      * and `failOnWarning` are enabled - it should fail
      */
     @Test
+    @Suppress("FunctionName")
     fun `should fail with DokkaException and readable message if failOnWarning is triggered`() {
         val result = createGradleRunner(
             "-info",
@@ -58,7 +57,7 @@ class ConfigurationTest(override val versions: BuildVersions) : AbstractGradleIn
         result.output.contains(
             """
                FAILURE: Build failed with an exception\\.
-
+               
                \* What went wrong:
                Execution failed for task ':dokkaHtml'\\.
                > Failed with warningCount=\d and errorCount=\d

diff --git a/kotlin-analysis/src/main/kotlin/org/jetbrains/dokka/analysis/KotlinAnalysis.kt b/kotlin-analysis/src/main/kotlin/org/jetbrains/dokka/analysis/KotlinAnalysis.kt
@@ -1,5 +1,3 @@
-@file:Suppress("FunctionName")
-
 package org.jetbrains.dokka.analysis
 
 import org.jetbrains.dokka.DokkaConfiguration.DokkaSourceSet
@@ -9,6 +7,7 @@ import org.jetbrains.dokka.plugability.DokkaContext
 import org.jetbrains.dokka.utilities.DokkaLogger
 import java.io.Closeable
 
+@Suppress("FunctionName")
 fun ProjectKotlinAnalysis(
     sourceSets: List<DokkaSourceSet>,
     logger: DokkaLogger,
@@ -30,6 +29,7 @@ fun ProjectKotlinAnalysis(
  *  Usually the analysis created for samples is short-lived and can be closed right after
  *  it's been used, there's no need to wait for [projectKotlinAnalysis] to be closed as it must be handled separately.
  */
+@Suppress("FunctionName")
 fun SamplesKotlinAnalysis(
     sourceSets: List<DokkaSourceSet>,
     logger: DokkaLogger,
@@ -46,7 +46,7 @@ fun SamplesKotlinAnalysis(
                 sourceSet = sourceSet,
                 analysisConfiguration = analysisConfiguration
             )
-    }
+        }
 
     return EnvironmentKotlinAnalysis(environments, projectKotlinAnalysis)
 }
@@ -59,13 +59,15 @@ class DokkaAnalysisConfiguration(
     val ignoreCommonBuiltIns: Boolean = false
 )
 
-@Deprecated(message = "Construct using list of DokkaSourceSets and logger",
+@Deprecated(
+    message = "Construct using list of DokkaSourceSets and logger",
     replaceWith = ReplaceWith("KotlinAnalysis(context.configuration.sourceSets, context.logger)")
 )
 fun KotlinAnalysis(context: DokkaContext): KotlinAnalysis =
     ProjectKotlinAnalysis(context.configuration.sourceSets, context.logger)
 
-@Deprecated(message = "It was renamed to `ProjectKotlinAnalysis`",
+@Deprecated(
+    message = "It was renamed to `ProjectKotlinAnalysis`",
     replaceWith = ReplaceWith("ProjectKotlinAnalysis(sourceSets, logger, analysisConfiguration)")
 )
 fun KotlinAnalysis(
@@ -85,11 +87,13 @@ abstract class KotlinAnalysis(
     operator fun get(key: DokkaSourceSet): AnalysisContext {
         return get(key.sourceSetID)
     }
+
     operator fun get(key: DokkaSourceSetID): AnalysisContext {
         return find(key)
             ?: parent?.get(key)
-            ?: throw IllegalStateException("Missing EnvironmentAndFacade for sourceSet ${key}")
+            ?: throw IllegalStateException("Missing EnvironmentAndFacade for sourceSet $key")
     }
+
     protected abstract fun find(sourceSetID: DokkaSourceSetID): AnalysisContext?
 }
 
@@ -105,5 +109,3 @@ internal open class EnvironmentKotlinAnalysis(
         environments.values.forEach(AnalysisContext::close)
     }
 }
-
-
diff --git a/...e/src/main/kotlin/parsers/moduleAndPackage/ModuleAndPackageDocumentationParsingContext.kt b/...e/src/main/kotlin/parsers/moduleAndPackage/ModuleAndPackageDocumentationParsingContext.kt
@@ -1,5 +1,3 @@
-@file:Suppress("FunctionName")
-
 package org.jetbrains.dokka.base.parsers.moduleAndPackage
 
 import org.jetbrains.dokka.analysis.DokkaResolutionFacade

diff --git a/plugins/base/src/main/kotlin/parsers/moduleAndPackage/parseModuleAndPackageDocumentation.kt b/plugins/base/src/main/kotlin/parsers/moduleAndPackage/parseModuleAndPackageDocumentation.kt
@@ -1,5 +1,3 @@
-@file:Suppress("FunctionName")
-
 package org.jetbrains.dokka.base.parsers.moduleAndPackage
 
 fun parseModuleAndPackageDocumentation(
@@ -12,4 +10,3 @@ fun parseModuleAndPackageDocumentation(
         documentation = context.parse(fragment)
     )
 }
-
diff --git a/...ns/base/src/main/kotlin/transformers/documentables/ModuleAndPackageDocumentationReader.kt b/...ns/base/src/main/kotlin/transformers/documentables/ModuleAndPackageDocumentationReader.kt
@@ -1,5 +1,3 @@
-@file:Suppress("FunctionName")
-
 package org.jetbrains.dokka.base.transformers.documentables
 
 import org.jetbrains.dokka.DokkaConfiguration

diff --git a/...s/gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/GradlePackageOptionsBuilder.kt b/...s/gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/GradlePackageOptionsBuilder.kt
@@ -1,5 +1,3 @@
-@file:Suppress("FunctionName")
-
 package org.jetbrains.dokka.gradle
 
 import org.gradle.api.Project

diff --git a/runners/gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/dokkaBootstrapFactory.kt b/runners/gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/dokkaBootstrapFactory.kt
@@ -1,5 +1,3 @@
-@file:Suppress("FunctionName")
-
 package org.jetbrains.dokka.gradle
 
 import org.gradle.api.artifacts.Configuration

diff --git a/runners/gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/dokkaSourceSetIDFactory.kt b/runners/gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/dokkaSourceSetIDFactory.kt
@@ -1,5 +1,3 @@
-@file:Suppress("FunctionName")
-
 package org.jetbrains.dokka.gradle
 
 import org.gradle.api.NamedDomainObjectFactory
@@ -10,6 +8,7 @@ internal fun DokkaSourceSetID(task: Task, sourceSetName: String): DokkaSourceSet
     return DokkaSourceSetID(task.path, sourceSetName)
 }
 
+@Suppress("FunctionName")
 internal fun Task.DokkaSourceSetIdFactory() = NamedDomainObjectFactory<DokkaSourceSetID> { name ->
     DokkaSourceSetID(this@DokkaSourceSetIdFactory, name)
 }
diff --git a/...s/gradle-plugin/src/test/kotlin/org/jetbrains/dokka/gradle/GradleDokkaSourceSetBuilder.kt b/...s/gradle-plugin/src/test/kotlin/org/jetbrains/dokka/gradle/GradleDokkaSourceSetBuilder.kt
@@ -1,10 +1,9 @@
-@file:Suppress("TestFunctionName")
-
 package org.jetbrains.dokka.gradle
 
 import org.gradle.api.Project
 import org.jetbrains.dokka.DokkaSourceSetID
 
+@Suppress("TestFunctionName")
 fun GradleDokkaSourceSetBuilder(name: String, project: Project, sourceSetScopeId: String = "${project.path}:test"):
         GradleDokkaSourceSetBuilder {
     return GradleDokkaSourceSetBuilder(name, project) { DokkaSourceSetID(sourceSetScopeId, it) }

diff --git a/...adle-plugin/src/test/kotlin/org/jetbrains/dokka/gradle/GradleDokkaSourceSetBuilderTest.kt b/...adle-plugin/src/test/kotlin/org/jetbrains/dokka/gradle/GradleDokkaSourceSetBuilderTest.kt
@@ -1,5 +1,3 @@
-@file:Suppress("TestFunctionName")
-
 package org.jetbrains.dokka.gradle
 
 import com.android.build.gradle.internal.api.DefaultAndroidSourceSet
@@ -13,7 +11,6 @@ import kotlin.test.*
 
 class GradleDokkaSourceSetBuilderTest {
 
-
     private val project = ProjectBuilder.builder().withName("root").build()
 
     @Test
@@ -488,5 +485,6 @@ class GradleDokkaSourceSetBuilderTest {
     }
 }
 
+@Suppress("TestFunctionName")
 private fun GradleDokkaSourceSetBuilder(name: String, project: Project) =
     GradleDokkaSourceSetBuilder(name, project, project.path)