Updated docs for onCheck properties

Resolves #213

Author: shanshin

README.md

@@ -248,7 +248,7 @@ kover {
     }
 
     xmlReport {
-        onCheck.set(false) // true to run koverXmlReport task during the execution of the check task
+        onCheck.set(false) // true to run koverXmlReport task during the execution of the check task (if it exists) of the current project
         reportFile.set(layout.buildDirectory.file("my-project-report/result.xml")) // change report file name
         overrideFilters { 
             classes { // override common class filter
@@ -259,7 +259,7 @@ kover {
     }
 
     htmlReport {
-        onCheck.set(false) // true to run koverHtmlReport task during the execution of the check task
+        onCheck.set(false) // true to run koverHtmlReport task during the execution of the check task (if it exists) of the current project
         reportDir.set(layout.buildDirectory.dir("my-project-report/html-result")) // change report directory
         overrideFilters { 
             classes { // override common class filter
@@ -270,7 +270,7 @@ kover {
     }
 
     verify {
-        onCheck.set(true) // true to run koverVerify task during the execution of the check task 
+        onCheck.set(true) // true to run koverVerify task during the execution of the check task (if it exists) of the current project 
         rule { // add verification rule
             isEnabled = true // false to disable rule checking
             name = null // custom name for the rule
@@ -312,7 +312,7 @@ kover {
     }
 
     xmlReport {
-        onCheck.set(false) // true to run koverXmlReport task during the execution of the check task
+        onCheck.set(false) // true to run koverXmlReport task during the execution of the check task (if it exists) of the current project
         reportFile.set(layout.buildDirectory.file("my-project-report/result.xml")) // change report file name
         overrideFilters {
             classes { // override common class filter
@@ -323,7 +323,7 @@ kover {
     }
 
     htmlReport {
-        onCheck.set(false) // true to run koverHtmlReport task during the execution of the check task
+        onCheck.set(false) // true to run koverHtmlReport task during the execution of the check task (if it exists) of the current project
         reportDir.set(layout.buildDirectory.dir("my-project-report/html-result")) // change report directory
         overrideFilters {
             classes { // override common class filter
@@ -334,7 +334,7 @@ kover {
     }
 
     verify {
-      onCheck.set(true) // true to run koverVerify task during the execution of the check task 
+      onCheck.set(true) // true to run koverVerify task during the execution of the check task (if it exists) of the current project
       rule { // add verification rule
           enabled = true // false to disable rule checking
           name = null // custom name for the rule
@@ -392,7 +392,7 @@ koverMerged {
 
 
     xmlReport {
-        onCheck.set(false) // true to run koverMergedXmlReport task during the execution of the check task
+        onCheck.set(false) // true to run koverMergedXmlReport task during the execution of the check task (if it exists) of the current project
         reportFile.set(layout.buildDirectory.file("my-merged-report/result.xml")) // change report file name
         overrideClassFilter { // override common class filter
             includes += "com.example2.*" // override class inclusion rules
@@ -401,7 +401,7 @@ koverMerged {
     }
 
     htmlReport {
-        onCheck.set(false) // true to run koverMergedHtmlReport task during the execution of the check task
+        onCheck.set(false) // true to run koverMergedHtmlReport task during the execution of the check task (if it exists) of the current project
         reportDir.set(layout.buildDirectory.dir("my-merged-report/html-result")) // change report directory
         overrideClassFilter { // override common class filter
             includes += "com.example2.*" // override class inclusion rules
@@ -410,7 +410,7 @@ koverMerged {
     }
 
     verify {
-        onCheck.set(true) // true to run koverMergedVerify task during the execution of the check task 
+        onCheck.set(true) // true to run koverMergedVerify task during the execution of the check task (if it exists) of the current project 
         rule { // add verification rule
             isEnabled = true // false to disable rule checking
             name = null // custom name for the rule
@@ -453,7 +453,7 @@ koverMerged {
   
   
     xmlReport {
-        onCheck.set(false) // true to run koverMergedXmlReport task during the execution of the check task
+        onCheck.set(false) // true to run koverMergedXmlReport task during the execution of the check task (if it exists) of the current project
         reportFile.set(layout.buildDirectory.file("my-merged-report/result.xml")) // change report file name
         overrideClassFilter { // override common class filter
             includes.add("com.example2.*") // override class inclusion rules
@@ -462,7 +462,7 @@ koverMerged {
     }
   
     htmlReport {
-        onCheck.set(false) // true to run koverMergedHtmlReport task during the execution of the check task
+        onCheck.set(false) // true to run koverMergedHtmlReport task during the execution of the check task (if it exists) of the current project
         reportDir.set(layout.buildDirectory.dir("my-merged-report/html-result")) // change report directory
         overrideClassFilter { // override common class filter
             includes.add("com.example2.*") // override class inclusion rules
@@ -471,7 +471,7 @@ koverMerged {
     }
   
     verify {
-        onCheck.set(true) // true to run koverMergedVerify task during the execution of the check task 
+        onCheck.set(true) // true to run koverMergedVerify task during the execution of the check task (if it exists) of the current project
         rule { // add verification rule
             isEnabled = true // false to disable rule checking
             name = null // custom name for the rule

src/main/kotlin/kotlinx/kover/api/KoverConfig.kt

@@ -190,7 +190,7 @@ public open class KoverProjectXmlConfig @Inject constructor(objects: ObjectFacto
     internal val filters: KoverProjectFilters = objects.newInstance(KoverProjectFilters::class.java, objects)
 
     /**
-     * Specifies whether the XML report generation task should be executed before the `check` task.
+     * Specifies whether the XML report generation task should be executed before the `check` task (if it exists) of the current project.
      *
      * `false` by default.
      */
@@ -216,7 +216,7 @@ public open class KoverProjectHtmlConfig @Inject constructor(private val objects
     internal val taskFilters: KoverProjectFilters = objects.newInstance(KoverProjectFilters::class.java, objects)
 
     /**
-     * Specifies whether the HTML report generation task should be executed before the `check` task.
+     * Specifies whether the HTML report generation task should be executed before the `check` task (if it exists) of the current project.
      *
      * `false` by default.
      */
@@ -311,7 +311,7 @@ public open class KoverMergedXmlConfig @Inject constructor(private val objects:
     internal val classFilter: Property<KoverClassFilter> = objects.property(KoverClassFilter::class.java)
 
     /**
-     * Specifies whether the merged XML report generation task should be executed before the `check` task.
+     * Specifies whether the merged XML report generation task should be executed before the `check` task (if it exists) of the current project.
      */
     public val onCheck: Property<Boolean> = objects.property(Boolean::class.java)
 
@@ -334,7 +334,7 @@ public open class KoverMergedHtmlConfig @Inject constructor(private val objects:
     internal val classFilter: Property<KoverClassFilter> = objects.property(KoverClassFilter::class.java)
 
     /**
-     * Specifies whether the merged HTML report generation task should be executed before the `check` task.
+     * Specifies whether the merged HTML report generation task should be executed before the `check` task (if it exists) of the current project.
      */
     public val onCheck: Property<Boolean> = objects.property(Boolean::class.java)
 
@@ -368,7 +368,7 @@ public open class KoverVerifyConfig @Inject constructor(private val objects: Obj
     internal val rules: ListProperty<VerificationRule> = objects.listProperty(VerificationRule::class.java)
 
     /**
-     * Specifies whether the verification task should be executed before the `check` task.
+     * Specifies whether the verification task should be executed before the `check` task (if it exists) of the current project.
      *
      * By default, `true` for project reports and `false` for merged.
      */