Skip to content

Commit f80179f

Browse files
committed
Add some kdoc
1 parent f733b96 commit f80179f

File tree

4 files changed

+60
-2
lines changed

4 files changed

+60
-2
lines changed

src/main/kotlin/KotlinKlibAbiBuildTask.kt

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,20 +13,32 @@ import org.gradle.api.tasks.TaskAction
1313
import org.jetbrains.kotlin.library.abi.*
1414

1515
/**
16-
* Generates a text file with a ABI dump for a single klib.
16+
* Generates a text file with a KLib ABI dump for a single klib.
1717
*/
1818
public abstract class KotlinKlibAbiBuildTask : BuildTaskBase() {
1919

20+
/**
21+
* Path to a klib to dump.
22+
*/
2023
@InputFiles
2124
public lateinit var klibFile: FileCollection
2225

26+
/**
27+
* Bind this task with a klib compilation.
28+
*/
2329
@InputFiles
2430
public lateinit var compilationDependencies: FileCollection
2531

32+
/**
33+
* Refer to [KlibValidationSettings.signatureVersion] for details.
34+
*/
2635
@Optional
2736
@get:Input
2837
public var signatureVersion: Int? = null
2938

39+
/**
40+
* Name of a target [klibFile] was compiled for.
41+
*/
3042
@Input
3143
public lateinit var target: String
3244

src/main/kotlin/KotlinKlibExtractSupportedTargetsAbiTask.kt

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,18 +20,33 @@ public abstract class KotlinKlibExtractSupportedTargetsAbiTask : DefaultTask() {
2020
@get:Internal
2121
internal val projectName = project.name
2222

23+
/**
24+
* Merged KLib dump that should be filtered by this task.
25+
*/
2326
@InputFiles
2427
public lateinit var inputAbiFile: File
2528

29+
/**
30+
* A path to the resulting dump file.
31+
*/
2632
@OutputFile
2733
public lateinit var outputAbiFile: File
2834

35+
/**
36+
* Provider returning targets supported by the host compiler.
37+
*/
2938
@get:Input
3039
public lateinit var targets: Provider<Set<String>>
3140

41+
/**
42+
* Refer to [KlibValidationSettings.strictValidation] for details.
43+
*/
3244
@Input
3345
public var strictValidation: Boolean = false
3446

47+
/**
48+
* Refer to [KlibValidationSettings.useTargetGroupAliases] for details.
49+
*/
3550
@Input
3651
public var groupTargetNames: Boolean = true
3752

src/main/kotlin/KotlinKlibInferAbiForUnsupportedTargetTask.kt

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ import java.io.File
1616

1717
/**
1818
* Task infers a possible KLib ABI dump for an unsupported target.
19-
* To infer a dump, tasks walks up the default targets hierarchy tree starting from the unsupported
19+
* To infer a dump, tasks walk up the default targets hierarchy tree starting from the unsupported
2020
* target until it finds a node corresponding to a group of targets having at least one supported target.
2121
* After that, dumps generated for such supported targets are merged and declarations that are common to all
2222
* of them are considered as a common ABI that most likely will be shared by the unsupported target.
@@ -28,21 +28,40 @@ public abstract class KotlinKlibInferAbiForUnsupportedTargetTask : DefaultTask()
2828
@get:Internal
2929
internal val projectName = project.name
3030

31+
/**
32+
* The name of a target to infer a dump for.
33+
*/
3134
@Input
3235
public lateinit var unsupportedTarget: String
3336

37+
/**
38+
* A root directory containing dumps successfully generated for each supported target.
39+
* It is assumed that this directory contains subdirectories named after targets.
40+
*/
3441
@InputFiles
3542
public lateinit var outputApiDir: String
3643

44+
/**
45+
* Set of all supported targets.
46+
*/
3747
@Input
3848
public lateinit var supportedTargets: Set<String>
3949

50+
/**
51+
* Previously generated merged ABI dump file, the golden image every dump should be verified against.
52+
*/
4053
@InputFiles
4154
public lateinit var inputImageFile: File
4255

56+
/**
57+
* The name of a dump file.
58+
*/
4359
@Input
4460
public lateinit var dumpFileName: String
4561

62+
/**
63+
* A path to an inferred dump file.
64+
*/
4665
@OutputFile
4766
public lateinit var outputFile: File
4867

src/main/kotlin/KotlinKlibMergeAbiTask.kt

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,16 +22,28 @@ public abstract class KotlinKlibMergeAbiTask : DefaultTask() {
2222
@get:Internal
2323
internal val projectName = project.name
2424

25+
/**
26+
* Set of targets whose dumps should be merged.
27+
*/
2528
@get:Input
2629
public val targets: Set<String>
2730
get() = targetToFile.keys
2831

32+
/**
33+
* A path to a resulting merged dump.
34+
*/
2935
@OutputFile
3036
public lateinit var mergedFile: File
3137

38+
/**
39+
* The name of a dump file.
40+
*/
3241
@Input
3342
public lateinit var dumpFileName: String
3443

44+
/**
45+
* Refer to [KlibValidationSettings.useTargetGroupAliases] for details.
46+
*/
3547
@Input
3648
public var groupTargetNames: Boolean = true
3749

0 commit comments

Comments
 (0)