Skip to content

Commit 4b3206d

Browse files
committed
Corrected KDoc.
1 parent ec1291f commit 4b3206d

File tree

1 file changed

+3
-10
lines changed

1 file changed

+3
-10
lines changed

build-logic/src/main/kotlin/org/sdkotlin/buildlogic/attributes/CurrentOsAttributeDisambiguationRule.kt

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,23 +2,16 @@ package org.sdkotlin.buildlogic.attributes
22

33
import org.gradle.api.attributes.AttributeDisambiguationRule
44
import org.gradle.api.attributes.MultipleCandidatesDetails
5-
import org.gradle.api.model.ObjectFactory
65
import org.gradle.nativeplatform.OperatingSystemFamily
76
import javax.inject.Inject
87

98
/**
109
* A rule to disambiguate between multiple candidates of the
11-
* [OperatingSystemFamily] attribute in Gradle. It ensures that the attribute
12-
* value most closely matching the current operating system is chosen.
10+
* [OperatingSystemFamily] attribute in Gradle. It ensures the variant matching
11+
* the current operating system is chosen (if there is such a candidate).
1312
*
14-
* The current operating system's attribute value must be set in the companion
15-
* object property [currentOsAttributeValue] during the project configuration
16-
* phase. This value is then used to determine the closest match among the
17-
* provided candidates during dependency resolution.
18-
*
19-
* @param currentOsAttributeValue the [OperatingSystemFamily] attribute value corresponding
13+
* @param currentOsAttribute the `OperatingSystemFamily` attribute corresponding
2014
* to the current operating system.
21-
* @param objects the Gradle [ObjectFactory].
2215
*/
2316
open class CurrentOsAttributeDisambiguationRule @Inject constructor(
2417
private val currentOsAttribute: OperatingSystemFamily,

0 commit comments

Comments
 (0)