diff options
author | Simon Ogorodnik <Simon.Ogorodnik@jetbrains.com> | 2017-12-11 19:03:28 +0300 |
---|---|---|
committer | Simon Ogorodnik <Simon.Ogorodnik@jetbrains.com> | 2017-12-11 19:03:28 +0300 |
commit | 7485016705c4364dcea0212b5bc816f326ad7a87 (patch) | |
tree | 6220d2aa5e10e700265f54007615f1d4ec8a02c1 /runners | |
parent | 5eb7059566ef8d674eda8b7a7dfb01425c9739c9 (diff) | |
download | dokka-7485016705c4364dcea0212b5bc816f326ad7a87.tar.gz dokka-7485016705c4364dcea0212b5bc816f326ad7a87.tar.bz2 dokka-7485016705c4364dcea0212b5bc816f326ad7a87.zip |
Add deprecation message for reportNotDocumented, in sake of #243
Diffstat (limited to 'runners')
-rw-r--r-- | runners/gradle-plugin/src/main/kotlin/main.kt | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/runners/gradle-plugin/src/main/kotlin/main.kt b/runners/gradle-plugin/src/main/kotlin/main.kt index 20d99c47..057efb98 100644 --- a/runners/gradle-plugin/src/main/kotlin/main.kt +++ b/runners/gradle-plugin/src/main/kotlin/main.kt @@ -51,6 +51,8 @@ object ClassloaderContainer { var fatJarClassLoader: ClassLoader? = null } +const val `deprecationMessage reportNotDocumented` = "Will be removed in 0.9.17, see dokka#243" + open class DokkaTask : DefaultTask() { fun defaultKotlinTasks() = with(ReflectDsl) { @@ -104,6 +106,15 @@ open class DokkaTask : DefaultTask() { @Input var includeNonPublic = false @Input var skipDeprecated = false @Input var skipEmptyPackages = true + + @Deprecated(`deprecationMessage reportNotDocumented`, replaceWith = ReplaceWith("reportUndocumented")) + var reportNotDocumented + get() = reportUndocumented + set(value) { + logger.warn("Dokka: reportNotDocumented is deprecated and " + `deprecationMessage reportNotDocumented`.decapitalize()) + reportUndocumented = value + } + @Input var reportUndocumented = true @Input var perPackageOptions: MutableList<PackageOptions> = arrayListOf() @Input var impliedPlatforms: MutableList<String> = arrayListOf() |