Skip to content

Commit 54452c0

Browse files
TapchicomaSpace Team
authored and
Space Team
committed
[Gradle] Add KDoc for KotlinTestRun
^KT-58858 In Progress
1 parent d10e47a commit 54452c0

File tree

1 file changed

+26
-7
lines changed
  • libraries/tools/kotlin-gradle-plugin-api/src/common/kotlin/org/jetbrains/kotlin/gradle/plugin

1 file changed

+26
-7
lines changed

libraries/tools/kotlin-gradle-plugin-api/src/common/kotlin/org/jetbrains/kotlin/gradle/plugin/KotlinTestRun.kt

+26-7
Original file line numberDiff line numberDiff line change
@@ -10,39 +10,58 @@ import org.gradle.api.file.FileCollection
1010
import org.gradle.api.tasks.testing.TestFilter
1111

1212
/**
13-
* @suppress TODO: KT-58858 add documentation
13+
* A [KotlinExecution] that runs configured tests.
1414
*/
1515
interface KotlinTestRun<out SourceType : KotlinExecution.ExecutionSource> : KotlinExecution<SourceType> {
16+
17+
/**
18+
* Configures filtering for executable tests using the provided [configureFilter] configuration.
19+
*/
1620
fun filter(configureFilter: TestFilter.() -> Unit)
1721

22+
/**
23+
* Configures filtering for executable tests using the provided [configureFilter] configuration.
24+
*/
1825
fun filter(configureFilter: Closure<*>)
1926
}
2027

2128
/**
22-
* @suppress TODO: KT-58858 add documentation
29+
* A [KotlinTargetExecution] that executes configured tests in the context of a specific [KotlinTarget].
2330
*/
2431
interface KotlinTargetTestRun<ExecutionSource : KotlinExecution.ExecutionSource> :
2532
KotlinTestRun<ExecutionSource>,
2633
KotlinTargetExecution<ExecutionSource>
2734

2835
/**
29-
* @suppress TODO: KT-58858 add documentation
36+
* A [KotlinExecution.ExecutionSource] that provides the [classpath] and [testClassesDirs] where JVM test classes can be found.
3037
*/
3138
interface JvmClasspathTestRunSource : KotlinExecution.ExecutionSource {
39+
40+
/**
41+
* The part of the classpath where JVM test classes are located for execution.
42+
*/
3243
val testClassesDirs: FileCollection
44+
45+
/**
46+
* The tests classpath.
47+
*
48+
* This includes dependencies and/or test framework classes such as JUnit, TestNG, or any other test framework classes.
49+
*/
3350
val classpath: FileCollection
3451
}
3552

3653
/**
37-
* @suppress TODO: KT-58858 add documentation
54+
* Configures the [JvmClasspathTestRunSource].
3855
*/
3956
interface ClasspathTestRunSourceSupport {
57+
4058
/**
41-
* Select the exact [classpath] to run the tests from.
59+
* Configures values for the [JvmClasspathTestRunSource].
4260
*
43-
* Only the classes from [testClasses] will be treated as tests.
61+
* Calling this method overwrites any already configured values in the [JvmClasspathTestRunSource].
4462
*
45-
* This overrides other [KotlinExecution.executionSource] selection options.
63+
* @param [classpath] Tests classpath
64+
* @param [testClassesDirs] Only the classes from this [FileCollection] are treated as tests.
4665
*/
4766
fun setExecutionSourceFrom(classpath: FileCollection, testClassesDirs: FileCollection)
4867
}

0 commit comments

Comments
 (0)