More doc fixes for 24.6.0 (firebase#4959)

Author: wu-hui

firebase-firestore/CHANGELOG.md

@@ -1,6 +1,10 @@
 # Unreleased
+* [fixed] Fixed stack overflow caused by deeply nested server timestamps (#4702).
 * [feature] Add new cache config APIs to customize SDK's cache setup.
 * [feature] Add LRU garbage collector to SDK's memory cache.
+* [changed] Mark isPersistenceEnabled and getCacheSizeBytes as deprecated from FirebaseFirestoreSettings.
+* [changed] Mark isPersistenceEnabled, getCacheSizeBytes, setPersistenceEnabled and setCacheSizeBytes 
+ from FirebaseFirestoreSettings.Builder as deprecated.
 * [changed] Internal changes to ensure alignment with other SDK releases.
 
 # 24.5.0

firebase-firestore/src/main/java/com/google/firebase/firestore/FirebaseFirestoreSettings.java

@@ -105,9 +105,9 @@ public Builder setSslEnabled(boolean value) {
  *
  * @return A settings object that uses local persistent storage as specified by the given
  * <tt>value</tt>.
- * @deprecated Use {@link
+ * @deprecated Instead, use {@link
  * FirebaseFirestoreSettings.Builder#setLocalCacheSettings(LocalCacheSettings)} to configure
- * SDK cache instead.
+ * SDK cache.
  */
  @NonNull
  @Deprecated
@@ -131,9 +131,9 @@ public Builder setPersistenceEnabled(boolean value) {
  *
  * @return A settings object on which the cache size is configured as specified by the given
  * {@code value}.
- * @deprecated Use {@link
+ * @deprecated Instead, use {@link
  * FirebaseFirestoreSettings.Builder#setLocalCacheSettings(LocalCacheSettings)} to configure
- * SDK cache instead.
+ * SDK cache.
  */
  @NonNull
  @Deprecated
@@ -157,7 +157,7 @@ public Builder setCacheSizeBytes(long value) {
  *
  * <p>When unspecified, {@link PersistentCacheSettings} will be used by default.
  *
- * <p>NOTE: Calling this setter and {@code setPersistenceEnabled()} or @{code
+ * <p>NOTE: Calling this setter and {@code setPersistenceEnabled()} or {@code
  * setCacheSizeBytes()} at the same time will throw an exception during SDK initialization.
  * Instead, use the configuration in the {@link PersistentCacheSettings} object to specify the
  * cache size.
@@ -196,8 +196,8 @@ public boolean isSslEnabled() {
 
  /**
  * @return boolean indicating whether local persistent storage is enabled or not.
- * @deprecated Build the {@code FirebaseFirestoreSettings} instance to check cache
- * configurations.
+ * @deprecated Instead, build the {@link FirebaseFirestoreSettings} instance to check the SDK
+ * cache configurations.
  */
  @Deprecated
  public boolean isPersistenceEnabled() {
@@ -206,8 +206,8 @@ public boolean isPersistenceEnabled() {
 
  /**
  * @return cache size for on-disk data.
- * @deprecated Build the {@code FirebaseFirestoreSettings} instance to check cache
- * configurations.
+ * @deprecated Instead, build the {@link FirebaseFirestoreSettings} instance to check the SDK
+ * cache configurations.
  */
  @Deprecated
  public long getCacheSizeBytes() {
@@ -297,7 +297,8 @@ public boolean isSslEnabled() {
  /**
  * Returns whether or not to use local persistent storage.
  *
- * @deprecated Use {@link FirebaseFirestoreSettings#getCacheSettings()} instead.
+ * @deprecated Instead, use {@link FirebaseFirestoreSettings#getCacheSettings()} to check which
+ * cache is used.
  */
  @Deprecated
  public boolean isPersistenceEnabled() {
@@ -312,7 +313,8 @@ public boolean isPersistenceEnabled() {
  * Returns the threshold for the cache size above which the SDK will attempt to collect the least
  * recently used documents.
  *
- * @deprecated Use {@link FirebaseFirestoreSettings#getCacheSettings()} instead.
+ * @deprecated Instead, use {@link FirebaseFirestoreSettings#getCacheSettings()} to check cache
+ * size.
  */
  @Deprecated
  public long getCacheSizeBytes() {

firebase-firestore/src/main/java/com/google/firebase/firestore/LocalCacheSettings.java

@@ -17,7 +17,7 @@
 /**
  * Marker interface implemented by all supported cache settings.
  *
- * <p>The two cache types supported are {@link PersistentCacheSettings} and {@link
- * MemoryCacheSettings}. Custom implementation is not supported by the SDK.
+ * <p>{@link PersistentCacheSettings} and {@link MemoryCacheSettings} are the two only cache types
+ * supported by the SDK. Custom implementation is not supported.
  */
 public interface LocalCacheSettings {}

firebase-firestore/src/main/java/com/google/firebase/firestore/MemoryCacheSettings.java

@@ -24,7 +24,7 @@
  * <p>To use, create an instance using {@link MemoryCacheSettings#newBuilder().build()}, then set
  * the instance to {@link
  * FirebaseFirestoreSettings.Builder#setLocalCacheSettings(LocalCacheSettings)}, and use the built
- * `FirebaseFirestoreSettings` instance to configure Firestore SDK.
+ * {@code FirebaseFirestoreSettings} instance to configure the Firestore SDK.
  */
 public final class MemoryCacheSettings implements LocalCacheSettings {
  private MemoryGarbageCollectorSettings gcSettings;
@@ -58,6 +58,7 @@ public String toString() {
  return "MemoryCacheSettings{gcSettings=" + getGarbageCollectorSettings() + "}";
  }
 
+ /** Returns the {@link MemoryGarbageCollectorSettings} object used to configure the SDK cache. */
  @NonNull
  public MemoryGarbageCollectorSettings getGarbageCollectorSettings() {
  return gcSettings;
@@ -75,6 +76,7 @@ public MemoryCacheSettings build() {
  return new MemoryCacheSettings(gcSettings);
  }
 
+ /** Uses the given garbage collector settings to configure memory cache. */
  @NonNull
  public Builder setGcSettings(@NonNull MemoryGarbageCollectorSettings gcSettings) {
  this.gcSettings = gcSettings;

firebase-firestore/src/main/java/com/google/firebase/firestore/PersistentCacheSettings.java

@@ -24,7 +24,7 @@
  * <p>To use, create an instance using {@link PersistentCacheSettings#newBuilder().build()}, then
  * set the instance to {@link
  * FirebaseFirestoreSettings.Builder#setLocalCacheSettings(LocalCacheSettings)}, and use the built
- * `FirebaseFirestoreSettings` instance to configure Firestore SDK.
+ * {@code FirebaseFirestoreSettings} instance to configure the Firestore SDK.
  */
 public final class PersistentCacheSettings implements LocalCacheSettings {
  /**