blob: 6d1e0ae46a3b21a11102511a2ec469cf033feadc (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
|
/*
* Copyright 2014-2023 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
*/
package org.jetbrains
import org.gradle.api.provider.Provider
import org.gradle.api.provider.ProviderFactory
import org.gradle.jvm.toolchain.JavaLanguageVersion
import org.jetbrains.kotlin.gradle.dsl.KotlinVersion
import javax.inject.Inject
/**
* Common build properties used to build Dokka subprojects.
*
* This is an extension created by the [org.jetbrains.conventions.Base_gradle] convention plugin.
*
* Default values are set in the root `gradle.properties`, and can be overridden via
* [project properties](https://docs.gradle.org/current/userguide/build_environment.html#sec:project_properties)
*/
abstract class DokkaBuildProperties @Inject constructor(
private val providers: ProviderFactory,
) {
/**
* The main version of Java that should be used to build Dokka source code.
*
* Updating the Java target is a breaking change.
*/
val mainJavaVersion: Provider<JavaLanguageVersion> =
dokkaProperty("javaToolchain.mainCompiler", JavaLanguageVersion::of)
/**
* The version of Java that should be used to run Dokka tests.
*
* This value is set in CI/CD environments to make sure that Dokka still works with different
* versions of Java.
*/
val testJavaLauncherVersion: Provider<JavaLanguageVersion> =
dokkaProperty("javaToolchain.testLauncher", JavaLanguageVersion::of)
.orElse(mainJavaVersion)
/**
* The Kotlin language level that Dokka artifacts are compiled to support.
*
* Updating the language level is a breaking change.
*/
val kotlinLanguageLevel: Provider<KotlinVersion> =
dokkaProperty("kotlinLanguageLevel", KotlinVersion::fromVersion)
private fun <T : Any> dokkaProperty(name: String, convert: (String) -> T) =
providers.gradleProperty("org.jetbrains.dokka.$name").map(convert)
companion object {
const val EXTENSION_NAME = "dokkaBuild"
}
}
|
