Update documentation: README.md and KtlintExtension#ignoreFailures

Author: jonasfa

README.md

@@ -318,7 +318,7 @@ ktlint {
     android = false
     outputToConsole = true
     outputColorName = "RED"
-    ignoreFailures = true
+    ignoreFailures = true // ignoring failures also decreases the log level from ERROR to WARN
     enableExperimentalRules = true
     additionalEditorconfigFile = file("/some/additional/.editorconfig")  // not supported with ktlint 0.47+
     additionalEditorconfig = [ // not supported until ktlint 0.49
@@ -373,7 +373,7 @@ configure<org.jlleitschuh.gradle.ktlint.KtlintExtension> {
     android.set(false)
     outputToConsole.set(true)
     outputColorName.set("RED")
-    ignoreFailures.set(true)
+    ignoreFailures.set(true) // ignoring failures also decreases the log level from ERROR to WARN
     enableExperimentalRules.set(true)
     additionalEditorconfigFile.set(file("/some/additional/.editorconfig")) // not supported with ktlint 0.47+
     additionalEditorconfig.set( // not supported until ktlint 0.49

plugin/src/main/kotlin/org/jlleitschuh/gradle/ktlint/KtlintExtension.kt

@@ -5,6 +5,7 @@ import org.gradle.api.NamedDomainObjectContainer
 import org.gradle.api.file.ConfigurableFileTree
 import org.gradle.api.file.ProjectLayout
 import org.gradle.api.file.RegularFileProperty
+import org.gradle.api.logging.LogLevel
 import org.gradle.api.model.ObjectFactory
 import org.gradle.api.provider.MapProperty
 import org.gradle.api.provider.Property
@@ -72,7 +73,10 @@ open class KtlintExtension @Inject internal constructor(
     /**
      * Whether or not to allow the build to continue if there are warnings;
      * defaults to {@code false}, as for any other static code analysis tool.
-     * <p>
+     *
+     * When set to `true`, issues are logged with [LogLevel.WARN] so that they're not printed when
+     * Gradle is invoked with `--quiet`. Otherwise, issues are logged with [LogLevel.ERROR].
+     *
      * Example: `ignoreFailures = true`
      */
     val ignoreFailures: Property<Boolean> = objectFactory.property { set(false) }