Fix various issues and inconsistencies in the Remote Config ref docs. (firebase#4964)

Author: danasilver

firebase-config/src/main/java/com/google/firebase/remoteconfig/FirebaseRemoteConfig.java

@@ -48,14 +48,12 @@
 import org.json.JSONObject;
 
 /**
- * Entry point for the Firebase Remote Config (FRC) API.
+ * Entry point for the Firebase Remote Config API.
  *
  * <p>Callers should first get the singleton object using {@link #getInstance()}, and then call
- * operations on that singleton object. The singleton contains the complete set of FRC parameter
- * values available to your app. The singleton also stores values fetched from the FRC Server until
- * they are made available for use with a call to {@link #activate()}.
- *
- * @author Miraziz Yusupov
+ * operations on that singleton object. The singleton contains the complete set of Remote Config
+ * parameter values available to your app. The singleton also stores values fetched from the Remote
+ * Config Server until they are made available for use with a call to {@link #activate()}.
  */
 public class FirebaseRemoteConfig {
  // -------------------------------------------------------------------------------
@@ -557,8 +555,8 @@ public Task<Void> reset() {
  * re-use the same connection to the backend.
  *
  * <p>Note: Real-time Remote Config requires the Firebase Remote Config Realtime API. See the <a
- * href="https://firebase.google.com/docs/remote-config/get-started#add-real-time-listener">Remote
- * Config Get Started </a> guide to enable the API.
+ * href="https://firebase.google.com/docs/remote-config/get-started?platform=android#add-real-time-listener">Remote
+ * Config Get Started</a> guide to enable the API.
  *
  * @param configUpdateListener A {@link ConfigUpdateListener} that can be used to respond to
  * config updates when they're fetched.

firebase-config/src/main/java/com/google/firebase/remoteconfig/FirebaseRemoteConfigClientException.java

@@ -20,8 +20,6 @@
 /**
  * A Firebase Remote Config internal issue that isn't caused by an interaction with the Firebase
  * Remote Config server.
- *
- * @author Miraziz Yusupov
  */
 public class FirebaseRemoteConfigClientException extends FirebaseRemoteConfigException {
  /** Creates a Firebase Remote Config client exception with the given message. */
@@ -36,8 +34,8 @@ public FirebaseRemoteConfigClientException(
  }
 
  /**
- * Creates a Firebase Remote Config client exception with the given message and
- * FirebaseRemoteConfigException code.
+ * Creates a Firebase Remote Config client exception with the given message and {@code
+ * FirebaseRemoteConfigException} code.
  */
  public FirebaseRemoteConfigClientException(@NonNull String detailMessage, @NonNull Code code) {
  super(detailMessage, code);

firebase-config/src/main/java/com/google/firebase/remoteconfig/FirebaseRemoteConfigException.java

@@ -75,6 +75,11 @@ public int value() {
  }
  }
 
+ /**
+ * Gets the {@link Code} representing the type of exception.
+ *
+ * @return A {@link Code} representing the type of exception.
+ */
  @NonNull
  public Code getCode() {
  return code;

firebase-config/src/main/java/com/google/firebase/remoteconfig/FirebaseRemoteConfigInfo.java

@@ -16,7 +16,7 @@
 
 import androidx.annotation.NonNull;
 
-/** Wraps the current state of the FirebaseRemoteConfig singleton object. */
+/** Wraps the current state of the {@link FirebaseRemoteConfig} singleton object. */
 public interface FirebaseRemoteConfigInfo {
  /**
  * Gets the timestamp (milliseconds since epoch) of the last successful fetch, regardless of
@@ -38,7 +38,7 @@ public interface FirebaseRemoteConfigInfo {
  int getLastFetchStatus();
 
  /**
- * Gets the current settings of the FirebaseRemoteConfig singleton object.
+ * Gets the current settings of the {@link FirebaseRemoteConfig} singleton object.
  *
  * @return A {@link FirebaseRemoteConfigSettings} object indicating the current settings.
  */

firebase-config/src/main/java/com/google/firebase/remoteconfig/FirebaseRemoteConfigServerException.java

@@ -21,8 +21,6 @@
 /**
  * A Firebase Remote Config internal issue caused by an interaction with the Firebase Remote Config
  * server.
- *
- * @author Miraziz Yusupov
  */
 public class FirebaseRemoteConfigServerException extends FirebaseRemoteConfigException {
  private final int httpStatusCode;

firebase-config/src/main/java/com/google/firebase/remoteconfig/FirebaseRemoteConfigSettings.java

@@ -19,11 +19,7 @@
 
 import androidx.annotation.NonNull;
 
-/**
- * Wraps the settings for {@link FirebaseRemoteConfig} operations.
- *
- * @author Lucas Png
- */
+/** Wraps the settings for {@link FirebaseRemoteConfig} operations. */
 public class FirebaseRemoteConfigSettings {
  private final long fetchTimeoutInSeconds;
  private final long minimumFetchInterval;
@@ -37,7 +33,7 @@ private FirebaseRemoteConfigSettings(Builder builder) {
  * Returns the fetch timeout in seconds.
  *
  * <p>The timeout specifies how long the client should wait for a connection to the Firebase
- * Remote Config servers.
+ * Remote Config server.
  */
  public long getFetchTimeoutInSeconds() {
  return fetchTimeoutInSeconds;
@@ -48,7 +44,7 @@ public long getMinimumFetchIntervalInSeconds() {
  return minimumFetchInterval;
  }
 
- /** Constructs a builder initialized with the current FirebaseRemoteConfigSettings. */
+ /** Constructs a builder initialized with the current {@link FirebaseRemoteConfigSettings}. */
  @NonNull
  public FirebaseRemoteConfigSettings.Builder toBuilder() {
  FirebaseRemoteConfigSettings.Builder frcBuilder = new FirebaseRemoteConfigSettings.Builder();
@@ -68,7 +64,7 @@ public static class Builder {
  * servers in seconds.
  *
  * <p>A fetch call will fail if it takes longer than the specified timeout to connect to or read
- * from the Remote Config servers.
+ * from the Remote Config server.
  *
  * @param duration Timeout duration in seconds. Should be a non-negative number.
  */
@@ -109,7 +105,7 @@ public Builder setMinimumFetchIntervalInSeconds(long duration) {
  * Returns the fetch timeout in seconds.
  *
  * <p>The timeout specifies how long the client should wait for a connection to the Firebase
- * Remote Config servers.
+ * Remote Config server.
  */
  public long getFetchTimeoutInSeconds() {
  return fetchTimeoutInSeconds;