Skip to content

Commit 3c7cb33

Browse files
πŸ“ Add docstrings to jdk-25
Docstrings generation was requested by @csikb. * #466 (comment) The following files were modified: * `buildSrc/src/main/kotlin/hu/bsstudio/gradle/JavaConventionPlugin.kt` * `buildSrc/src/main/kotlin/hu/bsstudio/gradle/JavaLibraryConventionPlugin.kt` * `buildSrc/src/main/kotlin/hu/bsstudio/gradle/KotlinConventionPlugin.kt`
1 parent 373be78 commit 3c7cb33

File tree

3 files changed

+17
-0
lines changed

3 files changed

+17
-0
lines changed

β€ŽbuildSrc/src/main/kotlin/hu/bsstudio/gradle/JavaConventionPlugin.ktβ€Ž

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,11 @@ import org.gradle.kotlin.dsl.configure
1010
import org.gradle.kotlin.dsl.get
1111

1212
class JavaConventionPlugin : Plugin<Project> {
13+
/**
14+
* Configures a Gradle project with Java conventions: applies the Java plugin, sets the Java toolchain language version to 25, and makes the `compileOnly` configuration extend from `annotationProcessor`.
15+
*
16+
* @param project The target Gradle project to configure.
17+
*/
1318
override fun apply(project: Project) {
1419
project.pluginManager.apply(JavaPlugin::class)
1520

β€ŽbuildSrc/src/main/kotlin/hu/bsstudio/gradle/JavaLibraryConventionPlugin.ktβ€Ž

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,11 @@ import org.gradle.kotlin.dsl.configure
1010
import org.gradle.kotlin.dsl.get
1111

1212
class JavaLibraryConventionPlugin : Plugin<Project> {
13+
/**
14+
* Configures the given Gradle project as a Java library: applies the Java Library plugin, sets the Java toolchain language version to 25, and makes the `compileOnly` configuration extend from `annotationProcessor`.
15+
*
16+
* @param project The target Gradle project to configure.
17+
*/
1318
override fun apply(project: Project) {
1419
project.pluginManager.apply(JavaLibraryPlugin::class)
1520

β€ŽbuildSrc/src/main/kotlin/hu/bsstudio/gradle/KotlinConventionPlugin.ktβ€Ž

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,13 @@ import org.gradle.kotlin.dsl.assign
66
import org.gradle.kotlin.dsl.withType
77

88
class KotlinConventionPlugin : Plugin<Project> {
9+
/**
10+
* Configures the project with Kotlin plugins and a consistent Kotlin compiler configuration.
11+
*
12+
* Applies the Kotlin JVM, Kotlin Spring and Kotlin JPA plugins, and configures all KotlinCompile
13+
* tasks to enable strict nullability checks, enable extra warnings, treat all warnings as errors,
14+
* and target JVM 25.
15+
*/
916
override fun apply(project: Project) {
1017
project.pluginManager.apply("org.jetbrains.kotlin.jvm")
1118
project.pluginManager.apply("org.jetbrains.kotlin.plugin.spring")

0 commit comments

Comments
Β (0)