Skip to content

Commit 9d738f6

Browse files
authored
Tweak the KDoc for outputDirConnection and dataBuildersOutputDirConnection (#6783)
1 parent 6a30066 commit 9d738f6

File tree

1 file changed

+8
-4
lines changed
  • libraries/apollo-gradle-plugin/src/main/kotlin/com/apollographql/apollo/gradle/api

1 file changed

+8
-4
lines changed

libraries/apollo-gradle-plugin/src/main/kotlin/com/apollographql/apollo/gradle/api/Service.kt

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -789,7 +789,7 @@ interface Service {
789789
* By default, the generated sources are connected to:
790790
* - main sourceSet for Kotlin projects
791791
* - commonMain sourceSet for Kotlin multiplatform projects
792-
* - main sourceSet for Android projects
792+
* - main variants for Android projects
793793
*/
794794
fun outputDirConnection(action: Action<in DirectoryConnection>)
795795

@@ -800,7 +800,7 @@ interface Service {
800800
* By default, the generated sources are connected to:
801801
* - main sourceSet for Kotlin projects
802802
* - commonMain sourceSet for Kotlin multiplatform projects
803-
* - main sourceSet for Android projects
803+
* - test variants for Android projects
804804
*/
805805
fun dataBuildersOutputDirConnection(action: Action<in DirectoryConnection>)
806806

@@ -844,12 +844,16 @@ interface Service {
844844
fun connectToAndroidComponent(component: Any, kotlin: Boolean)
845845

846846
/**
847-
* Connects the generated sources to all the Variants.
847+
* Connects the generated sources to the "main" components.
848+
* - When using AGP8, this uses `android.libraryVariants` and `android.applicationVariants`.
849+
* - When using AGP9+, this uses `onVariants(selector().all())`
848850
*/
849851
fun connectToAndroidVariants(kotlin: Boolean)
850852

851853
/**
852-
* Connects the generated sources to all the TestComponents.
854+
* Connects the generated sources to all "test" components.
855+
* - When using AGP8, this uses `android.testVariants` and `android.unitTestVariants`.
856+
* - When using AGP9+, this uses `variant.hostTests` and `variant.deviceTests`
853857
*/
854858
fun connectToAndroidTestComponents(kotlin: Boolean)
855859

0 commit comments

Comments
 (0)