Increased the readability of the Kover documentation

Resolves #486
PR #602

Co-authored-by: Leonid Startsev <sandwwraith@users.noreply.github.com>

kover-gradle-plugin/examples/android/minimal_kts/app/build.gradle.kts

@@ -53,7 +53,14 @@ kover {
         }
 
         variant("release") {
-            // filters for all report types only of 'release' build type
+            // verification ony for 'release' build variant
+            verify {
+                rule {
+                    minBound(50)
+                }
+            }
+
+            // filters for all report types only for 'release' build variant
             filters {
                 excludes {
                     androidGeneratedClasses()
@@ -64,6 +71,5 @@ kover {
                 }
             }
         }
-
     }
 }

kover-gradle-plugin/examples/android/multiproject-custom/app/build.gradle.kts

@@ -0,0 +1,57 @@
+plugins {
+    id ("com.android.application")
+    id ("org.jetbrains.kotlin.android")
+    id ("org.jetbrains.kotlinx.kover")
+}
+
+android {
+    namespace = "kotlinx.kover.test.android"
+    compileSdk = 32
+
+    defaultConfig {
+        applicationId = "kotlinx.kover.test.android"
+        minSdk = 21
+        targetSdk = 31
+        versionCode = 1
+        versionName = "1.0"
+
+        testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
+    }
+
+    buildTypes {
+        release {
+            isMinifyEnabled = true
+        }
+    }
+    compileOptions {
+        sourceCompatibility = JavaVersion.VERSION_1_8
+        targetCompatibility = JavaVersion.VERSION_1_8
+    }
+    kotlinOptions {
+        jvmTarget = "1.8"
+    }
+    buildFeatures {
+        viewBinding = true
+    }
+}
+
+dependencies {
+    implementation("androidx.core:core-ktx:1.8.0")
+    implementation("androidx.appcompat:appcompat:1.5.0")
+    implementation("com.google.android.material:material:1.6.1")
+    implementation("androidx.constraintlayout:constraintlayout:2.1.4")
+    testImplementation("junit:junit:4.13.2")
+}
+
+
+/*
+ * Kover configs
+ */
+
+kover {
+    currentProject {
+        createVariant("custom") {
+            add("release")
+        }
+    }
+}

kover-gradle-plugin/examples/android/multiproject-custom/app/src/main/AndroidManifest.xml

@@ -0,0 +1,24 @@
+<?xml version="1.0" encoding="utf-8"?>
+<manifest xmlns:android="http://schemas.android.com/apk/res/android">
+
+    <application android:label="@string/app_name">
+        <uses-library android:name="com.google.android.things" android:required="false" />
+
+        <activity android:name=".MainActivity"
+                  android:exported="true">
+            <intent-filter>
+                <action android:name="android.intent.action.MAIN" />
+
+                <category android:name="android.intent.category.LAUNCHER" />
+            </intent-filter>
+            <!-- Make this the first activity that is displayed when the device boots. -->
+            <intent-filter>
+                <action android:name="android.intent.action.MAIN" />
+
+                <category android:name="android.intent.category.HOME" />
+                <category android:name="android.intent.category.DEFAULT" />
+            </intent-filter>
+        </activity>
+    </application>
+
+</manifest>

kover-gradle-plugin/examples/android/multiproject-custom/app/src/main/java/kotlinx/kover/test/android/DebugUtil.kt

@@ -0,0 +1,7 @@
+package kotlinx.kover.test.android
+
+object DebugUtil {
+    fun log(message: String) {
+        println("DEBUG: $message")
+    }
+}

kover-gradle-plugin/examples/android/multiproject-custom/app/src/main/java/kotlinx/kover/test/android/MainActivity.kt

@@ -0,0 +1,13 @@
+package kotlinx.kover.test.android
+
+import android.os.Bundle
+import android.app.Activity
+
+class MainActivity : Activity() {
+
+    override fun onCreate(savedInstanceState: Bundle?) {
+        super.onCreate(savedInstanceState)
+        setContentView(R.layout.activity_main)
+    }
+
+}

kover-gradle-plugin/examples/android/multiproject-custom/app/src/main/java/kotlinx/kover/test/android/Maths.kt

@@ -0,0 +1,13 @@
+package kotlinx.kover.test.android
+
+object Maths {
+    fun sum(a: Int, b: Int): Int {
+        DebugUtil.log("invoked sum")
+        return a + b
+    }
+
+    fun sub(a: Int, b: Int): Int {
+        DebugUtil.log("invoked sub")
+        return a - b
+    }
+}

kover-gradle-plugin/examples/android/multiproject-custom/app/src/main/res/layout/activity_main.xml

@@ -0,0 +1,36 @@
+<?xml version="1.0" encoding="utf-8"?>
+<androidx.constraintlayout.widget.ConstraintLayout xmlns:android="http://schemas.android.com/apk/res/android"
+    xmlns:app="http://schemas.android.com/apk/res-auto"
+    xmlns:tools="http://schemas.android.com/tools"
+    android:layout_width="match_parent"
+    android:layout_height="match_parent"
+    tools:context=".MainActivity">
+
+    <TextView
+        android:id="@+id/main_label"
+        android:layout_width="wrap_content"
+        android:layout_height="wrap_content"
+        android:layout_marginStart="104dp"
+        android:layout_marginTop="28dp"
+        android:text="SERIALIZATION TEST"
+        android:textSize="20sp"
+        android:textStyle="bold"
+        app:layout_constraintStart_toStartOf="parent"
+        app:layout_constraintTop_toTopOf="parent" />
+
+    <EditText
+        android:id="@+id/encoded_text"
+        android:layout_width="373dp"
+        android:layout_height="411dp"
+        android:layout_marginStart="16dp"
+        android:layout_marginTop="16dp"
+        android:editable="false"
+        android:ems="10"
+        android:gravity="start|top"
+        android:inputType="textMultiLine"
+        android:textAlignment="viewStart"
+        android:textSize="12sp"
+        app:layout_constraintStart_toStartOf="parent"
+        app:layout_constraintTop_toBottomOf="@+id/main_label" />
+
+</androidx.constraintlayout.widget.ConstraintLayout>

kover-gradle-plugin/examples/android/multiproject-custom/app/src/main/res/values/colors.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="utf-8"?>
+<resources>
+    <color name="purple_200">#FFBB86FC</color>
+    <color name="purple_500">#FF6200EE</color>
+    <color name="purple_700">#FF3700B3</color>
+    <color name="teal_200">#FF03DAC5</color>
+    <color name="teal_700">#FF018786</color>
+    <color name="black">#FF000000</color>
+    <color name="white">#FFFFFFFF</color>
+</resources>

kover-gradle-plugin/examples/android/multiproject-custom/app/src/main/res/values/strings.xml

@@ -0,0 +1,3 @@
+<resources>
+    <string name="app_name">Android Test</string>
+</resources>

kover-gradle-plugin/examples/android/multiproject-custom/app/src/main/res/values/themes.xml

@@ -0,0 +1,4 @@
+<resources>
+
+    <style name="Theme.App" parent="android:Theme.Material.Light.DarkActionBar" />
+</resources>

kover-gradle-plugin/examples/android/multiproject-custom/app/src/test/java/kotlinx/kover/test/android/LocalTests.kt

@@ -0,0 +1,13 @@
+package kotlinx.kover.test.android
+
+import org.junit.Test
+
+import org.junit.Assert.*
+
+
+class LocalTests {
+    @Test
+    fun testDebugUtils() {
+        assertEquals(3, Maths.sum(1, 2))
+    }
+}

kover-gradle-plugin/examples/android/multiproject-custom/build.gradle.kts

@@ -0,0 +1,48 @@
+plugins {
+    id("com.android.application") version "7.4.0" apply false
+    id("com.android.library") version "7.4.0" apply false
+    id("org.jetbrains.kotlin.android") version "1.8.20" apply false
+    id("org.jetbrains.kotlinx.kover") version "0.8.0-Beta2"
+}
+
+dependencies {
+    kover(project(":app"))
+    kover(project(":lib"))
+}
+
+kover {
+    currentProject {
+        createVariant("custom") {
+        }
+    }
+
+    reports {
+        // filters for all report types of all build variants
+        filters {
+            excludes {
+                androidGeneratedClasses()
+            }
+        }
+
+        variant("custom") {
+            // verification ony for 'custom' report variant
+            verify {
+                rule {
+                    minBound(50)
+                }
+            }
+
+            // filters for all report types only of 'custom' build type
+            filters {
+                excludes {
+                    androidGeneratedClasses()
+                    classes(
+                        // excludes debug classes
+                        "*.DebugUtil"
+                    )
+                }
+            }
+        }
+
+    }
+}

kover-gradle-plugin/examples/android/multiproject-custom/gradle.properties

@@ -0,0 +1,23 @@
+# Project-wide Gradle settings.
+# IDE (e.g. Android Studio) users:
+# Gradle settings configured through the IDE *will override*
+# any settings specified in this file.
+# For more details on how to configure your build environment visit
+# http://www.gradle.org/docs/current/userguide/build_environment.html
+# Specifies the JVM arguments used for the daemon process.
+# The setting is particularly useful for tweaking memory settings.
+org.gradle.jvmargs=-Xmx2048m -Dfile.encoding=UTF-8
+# When configured, Gradle will run in incubating parallel mode.
+# This option should only be used with decoupled projects. More details, visit
+# http://www.gradle.org/docs/current/userguide/multi_project_builds.html#sec:decoupled_projects
+# org.gradle.parallel=true
+# AndroidX package structure to make it clearer which packages are bundled with the
+# Android operating system, and which are packaged with your app's APK
+# https://developer.android.com/topic/libraries/support-library/androidx-rn
+android.useAndroidX=true
+# Kotlin code style for this project: "official" or "obsolete":
+kotlin.code.style=official
+# Enables namespacing of each library's R class so that its R class includes only the
+# resources declared in the library itself and none from the library's dependencies,
+# thereby reducing the size of the R class for that library
+android.nonTransitiveRClass=true

kover-gradle-plugin/examples/android/multiproject-custom/lib/build.gradle.kts

@@ -0,0 +1,44 @@
+plugins {
+    id ("com.android.library")
+    id ("org.jetbrains.kotlin.android")
+    id ("org.jetbrains.kotlinx.kover")
+}
+
+android {
+    namespace = "kotlinx.kover.test.android"
+
+    compileSdk = 32
+
+    defaultConfig {
+        minSdk = 21
+
+        testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
+    }
+
+    buildTypes {
+        release {
+            isMinifyEnabled = true
+        }
+    }
+    compileOptions {
+        sourceCompatibility = JavaVersion.VERSION_1_8
+        targetCompatibility = JavaVersion.VERSION_1_8
+    }
+    kotlinOptions {
+        jvmTarget = "1.8"
+    }
+}
+
+dependencies {
+    implementation("androidx.core:core-ktx:1.8.0")
+    implementation("androidx.appcompat:appcompat:1.5.0")
+    testImplementation("junit:junit:4.13.2")
+}
+
+kover {
+    currentProject {
+        createVariant("custom") {
+            add("debug")
+        }
+    }
+}

kover-gradle-plugin/examples/android/multiproject-custom/lib/src/main/AndroidManifest.xml

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="utf-8"?>
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+    xmlns:tools="http://schemas.android.com/tools">
+
+    <application
+        android:allowBackup="true"
+        android:supportsRtl="true"
+        tools:targetApi="31">
+    </application>
+
+</manifest>

kover-gradle-plugin/examples/android/multiproject-custom/lib/src/main/java/kotlinx/kover/test/android/lib/DebugUtil.kt

@@ -0,0 +1,7 @@
+package kotlinx.kover.test.android.lib
+
+object DebugUtil {
+    fun log(message: String) {
+        println("LIB DEBUG: $message")
+    }
+}

kover-gradle-plugin/examples/android/multiproject-custom/lib/src/main/java/kotlinx/kover/test/android/lib/MagicFactory.kt

@@ -0,0 +1,8 @@
+package kotlinx.kover.test.android.lib
+
+object MagicFactory {
+    fun generate(): Int {
+        DebugUtil.log("generate Int")
+        return 42
+    }
+}

kover-gradle-plugin/examples/android/multiproject-custom/lib/src/test/java/kotlinx/kover/test/android/LocalLibTests.kt

@@ -0,0 +1,14 @@
+package kotlinx.kover.test.android
+
+import kotlinx.kover.test.android.lib.MagicFactory
+import org.junit.Test
+
+import org.junit.Assert.*
+
+
+class LocalLibTests {
+    @Test
+    fun testDebugUtils() {
+        assertEquals(42, MagicFactory.generate())
+    }
+}