diff options
| author | Ignat Beresnev <ignat.beresnev@jetbrains.com> | 2022-04-29 15:03:08 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-04-29 15:03:08 +0300 |
| commit | 8c218ff4dd5f970233c43845c19299fc74256389 (patch) | |
| tree | b6818183ce8faa2c58d6571ca1c86aa28d4f0431 /core | |
| parent | 84aacad29982240ae367b21e9d283d38dab672ae (diff) | |
| download | dokka-8c218ff4dd5f970233c43845c19299fc74256389.tar.gz dokka-8c218ff4dd5f970233c43845c19299fc74256389.tar.bz2 dokka-8c218ff4dd5f970233c43845c19299fc74256389.zip | |
Enable warnings as errors and fix all warnings (#2451)
* Enable warnings as errors and fix all warnings
* Enable skip-metadata-version-check compiler setting
Diffstat (limited to 'core')
4 files changed, 5 insertions, 2 deletions
diff --git a/core/src/main/kotlin/configuration.kt b/core/src/main/kotlin/configuration.kt index c7feb22e..c26faf28 100644 --- a/core/src/main/kotlin/configuration.kt +++ b/core/src/main/kotlin/configuration.kt @@ -235,7 +235,7 @@ interface DokkaConfiguration : Serializable { interface PackageOptions : Serializable { val matchingRegex: String - @Deprecated(message = "Use [documentedVisibilities] property for a more flexible control over documented visibilities") + @Deprecated("Use [documentedVisibilities] property for a more flexible control over documented visibilities") val includeNonPublic: Boolean val reportUndocumented: Boolean? val skipDeprecated: Boolean diff --git a/core/src/main/kotlin/defaultConfiguration.kt b/core/src/main/kotlin/defaultConfiguration.kt index 3ab1782c..8c7c8b5d 100644 --- a/core/src/main/kotlin/defaultConfiguration.kt +++ b/core/src/main/kotlin/defaultConfiguration.kt @@ -37,6 +37,7 @@ data class DokkaSourceSetImpl( override val dependentSourceSets: Set<DokkaSourceSetID> = emptySet(), override val samples: Set<File> = emptySet(), override val includes: Set<File> = emptySet(), + @Deprecated("Use [documentedVisibilities] property for a more flexible control over documented visibilities") override val includeNonPublic: Boolean = DokkaDefaults.includeNonPublic, override val reportUndocumented: Boolean = DokkaDefaults.reportUndocumented, override val skipEmptyPackages: Boolean = DokkaDefaults.skipEmptyPackages, @@ -79,6 +80,7 @@ data class SourceLinkDefinitionImpl( data class PackageOptionsImpl( override val matchingRegex: String, + @Deprecated("Use [documentedVisibilities] property for a more flexible control over documented visibilities") override val includeNonPublic: Boolean, override val reportUndocumented: Boolean?, override val skipDeprecated: Boolean, diff --git a/core/src/main/kotlin/pages/PageNodes.kt b/core/src/main/kotlin/pages/PageNodes.kt index 75e27dcc..c643fd4b 100644 --- a/core/src/main/kotlin/pages/PageNodes.kt +++ b/core/src/main/kotlin/pages/PageNodes.kt @@ -21,7 +21,7 @@ interface ContentPage : PageNode { val embeddedResources: List<String> @Deprecated("Deprecated. Remove its usages from your code.", - ReplaceWith("documentables.firstOrNull()") + ReplaceWith("this.documentables.firstOrNull()") ) val documentable: Documentable? get() = if (this is WithDocumentables) this.documentables.firstOrNull() else null diff --git a/core/test-api/src/main/kotlin/testApi/testRunner/TestDokkaConfigurationBuilder.kt b/core/test-api/src/main/kotlin/testApi/testRunner/TestDokkaConfigurationBuilder.kt index 623fcc2d..50ab3bad 100644 --- a/core/test-api/src/main/kotlin/testApi/testRunner/TestDokkaConfigurationBuilder.kt +++ b/core/test-api/src/main/kotlin/testApi/testRunner/TestDokkaConfigurationBuilder.kt @@ -106,6 +106,7 @@ class DokkaSourceSetBuilder( var externalDocumentationLinks: List<ExternalDocumentationLinkImpl> = emptyList(), var sourceLinks: List<SourceLinkDefinitionImpl> = emptyList() ) { + @Suppress("DEPRECATION") fun build() = DokkaSourceSetImpl( displayName = displayName, sourceSetID = DokkaSourceSetID(moduleName, name), |