dataconnect(docs): QueryRef/QuerySubscription: kdoc improvements, especially adding BoM version (#8196)

dconeybe · web-flow · commit b61c8cfa1c82 · 2026-05-21T17:02:25.000-04:00
diff --git a/firebase-dataconnect/src/main/kotlin/com/google/firebase/dataconnect/QueryRef.kt b/firebase-dataconnect/src/main/kotlin/com/google/firebase/dataconnect/QueryRef.kt
@@ -76,11 +76,11 @@ public interface QueryRef<Data, Variables> : OperationRef<Data, Variables> {
    *
    * ### Realtime updates (May 2026)
    *
-   * Starting with SDK version 17.3.0 (May 2026) query subscriptions gained support for realtime
-   * updates. See
+   * Starting with SDK version 17.3.0 (Firebase BoM 34.13.0, May 2026) query subscriptions gained
+   * support for realtime updates. See
    * [Get real-time updates from SQL Connect](https://firebase.google.com/docs/sql-connect/realtime)
    * for details about this feature in the entire product, and [QuerySubscription] for details
-   * specified to Android.
+   * specific to Android.
    *
    * Prior to SDK version 17.3.0, updates were _not_ realtime, and were _not_ pushed from the
    * server. Instead, the notifications were sent whenever the query was explicitly executed by
diff --git a/firebase-dataconnect/src/main/kotlin/com/google/firebase/dataconnect/QuerySubscription.kt b/firebase-dataconnect/src/main/kotlin/com/google/firebase/dataconnect/QuerySubscription.kt
@@ -24,10 +24,10 @@ import kotlinx.coroutines.flow.*
  *
  * ### Realtime updates (May 2026)
  *
- * Starting with SDK version 17.3.0 (May 2026) query subscriptions gained support for realtime
- * updates. See
+ * Starting with SDK version 17.3.0 (Firebase BoM 34.13.0, May 2026) query subscriptions gained
+ * support for realtime updates. See
  * [Get real-time updates from SQL Connect](https://firebase.google.com/docs/sql-connect/realtime)
- * for details about this feature in the entire product.
+ * for details.
  *
  * Prior to SDK version 17.3.0, updates were _not_ realtime, and were _not_ pushed from the server.
  * Instead, the notifications were sent whenever the query was explicitly executed by calling
@@ -73,8 +73,8 @@ public interface QuerySubscription<Data, Variables> {
   /**
    * A cold flow that collects the query results as they become available.
    *
-   * Starting with SDK version 17.3.0 (May 2026) query subscriptions gained support for realtime
-   * updates. See [QuerySubscription] for details.
+   * Starting with SDK version 17.3.0 (Firebase BoM 34.13.0, May 2026) query subscriptions gained
+   * support for realtime updates. See [QuerySubscription] for details.
    */
   public val flow: Flow<QuerySubscriptionResult<Data, Variables>>
 

Original file line number	Diff line number	Diff line change
`@@ -76,11 +76,11 @@ public interface QueryRef<Data, Variables> : OperationRef<Data, Variables> {`
`76`	`76`	`*`
`77`	`77`	`* ### Realtime updates (May 2026)`
`78`	`78`	`*`
`79`		`- * Starting with SDK version 17.3.0 (May 2026) query subscriptions gained support for realtime`
`80`		`- * updates. See`
	`79`	`+ * Starting with SDK version 17.3.0 (Firebase BoM 34.13.0, May 2026) query subscriptions gained`
	`80`	`+ * support for realtime updates. See`
`81`	`81`	`* [Get real-time updates from SQL Connect](https://firebase.google.com/docs/sql-connect/realtime)`
`82`	`82`	`* for details about this feature in the entire product, and [QuerySubscription] for details`
`83`		`- * specified to Android.`
	`83`	`+ * specific to Android.`
`84`	`84`	`*`
`85`	`85`	`* Prior to SDK version 17.3.0, updates were _not_ realtime, and were _not_ pushed from the`
`86`	`86`	`* server. Instead, the notifications were sent whenever the query was explicitly executed by`
Original file line number	Diff line number	Diff line change
`@@ -24,10 +24,10 @@ import kotlinx.coroutines.flow.*`
`24`	`24`	`*`
`25`	`25`	`* ### Realtime updates (May 2026)`
`26`	`26`	`*`
`27`		`- * Starting with SDK version 17.3.0 (May 2026) query subscriptions gained support for realtime`
`28`		`- * updates. See`
	`27`	`+ * Starting with SDK version 17.3.0 (Firebase BoM 34.13.0, May 2026) query subscriptions gained`
	`28`	`+ * support for realtime updates. See`
`29`	`29`	`* [Get real-time updates from SQL Connect](https://firebase.google.com/docs/sql-connect/realtime)`
`30`		`- * for details about this feature in the entire product.`
	`30`	`+ * for details.`
`31`	`31`	`*`
`32`	`32`	`* Prior to SDK version 17.3.0, updates were _not_ realtime, and were _not_ pushed from the server.`
`33`	`33`	`* Instead, the notifications were sent whenever the query was explicitly executed by calling`
`@@ -73,8 +73,8 @@ public interface QuerySubscription<Data, Variables> {`
`73`	`73`	`/**`
`74`	`74`	`* A cold flow that collects the query results as they become available.`
`75`	`75`	`*`
`76`		`- * Starting with SDK version 17.3.0 (May 2026) query subscriptions gained support for realtime`
`77`		`- * updates. See [QuerySubscription] for details.`
	`76`	`+ * Starting with SDK version 17.3.0 (Firebase BoM 34.13.0, May 2026) query subscriptions gained`
	`77`	`+ * support for realtime updates. See [QuerySubscription] for details.`
`78`	`78`	`*/`
`79`	`79`	`public val flow: Flow<QuerySubscriptionResult<Data, Variables>>`
`80`	`80`