Add Kotlindoc-only publishing and enable for Dataconnect

Author: emilypgoogle

firebase-dataconnect/firebase-dataconnect.gradle.kts

@@ -28,6 +28,7 @@ firebaseLibrary {
   libraryGroup = "dataconnect"
   testLab.enabled = false
   publishJavadoc = true
+  onlyPublishKotlindoc = true
   releaseNotes {
     name.set("{{data_connect_short}}")
     versionName.set("data-connect")

plugins/src/main/java/com/google/firebase/gradle/plugins/BaseFirebaseLibraryPlugin.kt

@@ -56,6 +56,7 @@ abstract class BaseFirebaseLibraryPlugin : Plugin<Project> {
       project.gradle.sharedServices.registerIfAbsent<GMavenService, _>("gmaven")
       previewMode.convention("")
       publishJavadoc.convention(true)
+      onlyPublishKotlindoc.convention(false)
       artifactId.convention(project.name)
       groupId.convention(project.provider { project.group.toString() })
       libraryGroup.convention(artifactId)

plugins/src/main/java/com/google/firebase/gradle/plugins/DackkaGenerationTask.kt

@@ -98,6 +98,7 @@ data class ExternalDocumentationLink(val packageList: File, val externalLink: St
 abstract class GenerateDocumentationTask
 @Inject
 constructor(private val workerExecutor: WorkerExecutor) : GenerateDocumentationTaskExtension() {
+  @get:Input abstract val kotlindocOnly: Property<Boolean>
 
   @TaskAction
   fun build() {
@@ -120,7 +121,11 @@ constructor(private val workerExecutor: WorkerExecutor) : GenerateDocumentationT
         "java.lang.Override",
       )
     val annotationsNotToDisplayKotlin = listOf("kotlin.ExtensionFunctionType")
-
+    var javadoc: String? = "android"
+    if (kotlindocOnly.get()) {
+      // A null path disables javadoc generation
+      javadoc = null
+    }
     val jsonMap =
       mapOf(
         "moduleName" to "",
@@ -152,7 +157,7 @@ constructor(private val workerExecutor: WorkerExecutor) : GenerateDocumentationT
                 JSONObject(
                     mapOf(
                       "docRootPath" to "/docs/reference/",
-                      "javaDocsPath" to "android",
+                      "javaDocsPath" to javadoc,
                       "kotlinDocsPath" to "kotlin",
                       "projectPath" to "client/${clientName.get()}",
                       "includedHeadTagsPathJava" to

plugins/src/main/java/com/google/firebase/gradle/plugins/DackkaPlugin.kt

@@ -123,7 +123,8 @@ abstract class DackkaPlugin : Plugin<Project> {
     // TODO(b/270576405): remove afterEvalutate after fixed
     project.afterEvaluate {
       if (weShouldPublish(this)) {
-        val generateDocumentation = registerGenerateDackkaDocumentationTask(project)
+        val kdocOnly = publishKotlindocOnly(this)
+        val generateDocumentation = registerGenerateDackkaDocumentationTask(project, kdocOnly)
 
         val outputDir = generateDocumentation.flatMap { it.outputDirectory }
 
@@ -153,6 +154,14 @@ abstract class DackkaPlugin : Plugin<Project> {
    */
   private fun weShouldPublish(project: Project) = project.firebaseLibrary.publishJavadoc.get()
 
+  /**
+   * Checks if the [Project] should only release Kotlindocs
+   *
+   * This is done via the [FirebaseLibraryExtension.onlyPublishKotlindoc] property.
+   */
+  private fun publishKotlindocOnly(project: Project) =
+    project.firebaseLibrary.onlyPublishKotlindoc.get()
+
   /**
    * Applies common configuration to the [javadocConfig], that is otherwise not present.
    *
@@ -168,9 +177,10 @@ abstract class DackkaPlugin : Plugin<Project> {
   }
 
   private fun registerGenerateDackkaDocumentationTask(
-    project: Project
+    project: Project, kotlindocOnly: Boolean
   ): TaskProvider<GenerateDocumentationTask> =
     project.tasks.register<GenerateDocumentationTask>("generateDackkaDocumentation") {
+      this.kotlindocOnly.set(kotlindocOnly)
       with(project.extensions.getByType<LibraryExtension>()) {
         libraryVariants.all {
           if (name == "release") {

plugins/src/main/java/com/google/firebase/gradle/plugins/FirebaseLibraryExtension.kt

@@ -69,6 +69,20 @@ constructor(val project: Project, val type: LibraryType) {
    */
   abstract val publishJavadoc: Property<Boolean>
 
+  /**
+   * Only publish Kotlindocs instead of also publishing Javadocs for this library.
+   *
+   * Defaults to `false`.
+   *
+   * ```sh
+   * ./gradlew :firebase-common:kotlindoc
+   * ```
+   *
+   * @see [FirebaseLibraryExtension]
+   * @see publishJavadoc
+   */
+  abstract val onlyPublishKotlindoc: Property<Boolean>
+
   /**
    * Indicates the library is in a preview mode (such as `alpha` or `beta`).
    *