diff options
author | sebastian.sellmair <sebastian.sellmair@jetbrains.com> | 2020-06-09 13:40:03 +0200 |
---|---|---|
committer | Sebastian Sellmair <34319766+sellmair@users.noreply.github.com> | 2020-06-15 19:17:11 +0200 |
commit | ee425e0b1e39245f5e1106bbb0888e557e6fbfcd (patch) | |
tree | 4348359dc6c95129d33d2468ec3be86e4a95491e /runners | |
parent | bae2c8de63baf0c0b627a17ae179400fbc3c5be9 (diff) | |
download | dokka-ee425e0b1e39245f5e1106bbb0888e557e6fbfcd.tar.gz dokka-ee425e0b1e39245f5e1106bbb0888e557e6fbfcd.tar.bz2 dokka-ee425e0b1e39245f5e1106bbb0888e557e6fbfcd.zip |
Implement "failOnWarning" option
Diffstat (limited to 'runners')
4 files changed, 14 insertions, 1 deletions
diff --git a/runners/cli/src/main/kotlin/cli/main.kt b/runners/cli/src/main/kotlin/cli/main.kt index d217f83e..2ef08c2e 100644 --- a/runners/cli/src/main/kotlin/cli/main.kt +++ b/runners/cli/src/main/kotlin/cli/main.kt @@ -46,6 +46,10 @@ open class GlobalArguments(parser: DokkaArgumentsParser) : DokkaConfiguration { "Offline mode (do not download package lists from the Internet)" ) + override val failOnWarning: Boolean by parser.singleFlag( + listOf("-failOnWarning"), "Fail dokka task if at least one warning was reported" + ) + override val passesConfigurations: List<Arguments> by parser.repeatableFlag( listOf("-pass"), "Single dokka pass" diff --git a/runners/gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/DokkaTask.kt b/runners/gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/DokkaTask.kt index cad5e34f..2f821209 100644 --- a/runners/gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/DokkaTask.kt +++ b/runners/gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/DokkaTask.kt @@ -86,6 +86,9 @@ open class DokkaTask : DefaultTask(), Configurable { var disableAutoconfiguration: Boolean = false @Input + var failOnWarning: Boolean = false + + @Input var offlineMode: Boolean = false private var outputDiagnosticInfo: Boolean = @@ -199,6 +202,7 @@ open class DokkaTask : DefaultTask(), Configurable { passesConfigurations = defaultModulesConfiguration pluginsClasspath = pluginsClasspathConfiguration.resolve().toList() pluginsConfiguration = this@DokkaTask.pluginsConfiguration + failOnWarning = this@DokkaTask.failOnWarning } } diff --git a/runners/gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/configurationImplementations.kt b/runners/gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/configurationImplementations.kt index 2787bb4e..3e08d27d 100644 --- a/runners/gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/configurationImplementations.kt +++ b/runners/gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/configurationImplementations.kt @@ -131,6 +131,7 @@ class GradleDokkaConfigurationImpl: DokkaConfiguration { override var pluginsClasspath: List<File> = emptyList() override var pluginsConfiguration: Map<String, String> = mutableMapOf() override var modules: List<GradleDokkaModuleDescription> = emptyList() + override var failOnWarning: Boolean = false } class GradlePackageOptionsImpl: PackageOptions, Serializable { diff --git a/runners/maven-plugin/src/main/kotlin/DokkaMojo.kt b/runners/maven-plugin/src/main/kotlin/DokkaMojo.kt index 71fe5b40..5a739d5e 100644 --- a/runners/maven-plugin/src/main/kotlin/DokkaMojo.kt +++ b/runners/maven-plugin/src/main/kotlin/DokkaMojo.kt @@ -168,6 +168,9 @@ abstract class AbstractDokkaMojo : AbstractMojo() { var includeNonPublic: Boolean = false @Parameter + var failOnWarning: Boolean = false + + @Parameter var dokkaPlugins: List<Dependency> = emptyList() protected abstract fun getOutDir(): String @@ -250,7 +253,8 @@ abstract class AbstractDokkaMojo : AbstractMojo() { pluginsClasspath = getArtifactByAether("org.jetbrains.dokka", "dokka-base", dokkaVersion) + dokkaPlugins.map { getArtifactByAether(it.groupId, it.artifactId, it.version) }.flatten(), pluginsConfiguration = mutableMapOf(), //TODO implement as it is in Gradle - modules = emptyList() + modules = emptyList(), + failOnWarning = failOnWarning ) val gen = DokkaGenerator(configuration, logger) |