Adjust Functions Kotlin docs for release

Author: emilypgoogle

firebase-functions/src/main/java/com/google/firebase/functions/FirebaseFunctions.kt

@@ -151,7 +151,7 @@ internal constructor(
     }
   }
 
-  @Deprecated("Use {@link #useEmulator(String, int)} to connect to the emulator. ")
+  @Deprecated("Use useEmulator to connect to the emulator.")
   public fun useFunctionsEmulator(origin: String) {
     Preconditions.checkNotNull(origin, "origin cannot be null")
     urlFormat = "$origin/%2\$s/%1\$s/%3\$s"

firebase-functions/src/main/java/com/google/firebase/functions/FirebaseFunctionsException.kt

@@ -29,8 +29,8 @@ public class FirebaseFunctionsException : FirebaseException {
    */
   public enum class Code(private val value: Int) {
     /**
-     * The operation completed successfully. FirebaseFunctionsException will never have a status of
-     * OK.
+     * The operation completed successfully. `FirebaseFunctionsException` will never have a status of
+     * `OK`.
      */
     OK(0),
 
@@ -41,9 +41,9 @@ public class FirebaseFunctionsException : FirebaseException {
     UNKNOWN(2),
 
     /**
-     * Client specified an invalid argument. Note that this differs from FAILED_PRECONDITION.
-     * INVALID_ARGUMENT indicates arguments that are problematic regardless of the state of the
-     * system (e.g., an invalid field name).
+     * Client specified an invalid argument. Note that this differs from `FAILED_PRECONDITION`.
+     * `INVALID_ARGUMENT` indicates arguments that are problematic regardless of the state of the
+     * system (For example, an invalid field name).
      */
     INVALID_ARGUMENT(3),
 
@@ -126,12 +126,12 @@ public class FirebaseFunctionsException : FirebaseException {
       }
 
       /**
-       * Takes an HTTP status code and returns the corresponding FUNErrorCode error code. This is
+       * Takes an HTTP status code and returns the corresponding [Code] error code. This is
        * the standard HTTP status code -> error mapping defined in:
        * https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto
        *
        * @param status An HTTP status code.
-       * @return The corresponding Code, or Code.UNKNOWN if none.
+       * @return The corresponding `Code`, or `Code.UNKNOWN` if none.
        */
       @JvmStatic
       public fun fromHttpStatus(status: Int): Code {
@@ -157,7 +157,7 @@ public class FirebaseFunctionsException : FirebaseException {
   /**
    * Gets the error code for the operation that failed.
    *
-   * @return the code for the FirebaseFunctionsException
+   * @return the code for the `FirebaseFunctionsException`
    */
   public val code: Code
 
@@ -183,7 +183,7 @@ public class FirebaseFunctionsException : FirebaseException {
     this.details = details
   }
 
-  public companion object {
+  internal companion object {
     /**
      * Takes an HTTP response and returns the corresponding Exception if any.
      *
@@ -193,7 +193,7 @@ public class FirebaseFunctionsException : FirebaseException {
      * @return The corresponding Exception, or null if none.
      */
     @JvmStatic
-    public fun fromResponse(
+    internal fun fromResponse(
       code: Code,
       body: String?,
       serializer: Serializer

firebase-functions/src/main/java/com/google/firebase/functions/HttpsCallOptions.kt

@@ -17,22 +17,22 @@ import java.util.concurrent.TimeUnit
 import okhttp3.OkHttpClient
 
 /** An internal class for keeping track of options applied to an HttpsCallableReference. */
-public class HttpsCallOptions {
+internal class HttpsCallOptions {
   // The timeout to use for calls from references created by this Functions.
   private var timeout = DEFAULT_TIMEOUT
   private var timeoutUnits = DEFAULT_TIMEOUT_UNITS
   @JvmField public val limitedUseAppCheckTokens: Boolean
 
   /** Creates an (internal) HttpsCallOptions from the (external) [HttpsCallableOptions]. */
-  public constructor(publicCallableOptions: HttpsCallableOptions) {
+  internal constructor(publicCallableOptions: HttpsCallableOptions) {
     limitedUseAppCheckTokens = publicCallableOptions.limitedUseAppCheckTokens
   }
 
-  public constructor() {
+  internal constructor() {
     limitedUseAppCheckTokens = false
   }
 
-  public fun getLimitedUseAppCheckTokens(): Boolean {
+  internal fun getLimitedUseAppCheckTokens(): Boolean {
     return limitedUseAppCheckTokens
   }
 
@@ -42,7 +42,7 @@ public class HttpsCallOptions {
    * @param timeout The length of the timeout, in the given units.
    * @param units The units for the specified timeout.
    */
-  public fun setTimeout(timeout: Long, units: TimeUnit) {
+  internal fun setTimeout(timeout: Long, units: TimeUnit) {
     this.timeout = timeout
     timeoutUnits = units
   }
@@ -52,12 +52,12 @@ public class HttpsCallOptions {
    *
    * @return The timeout, in milliseconds.
    */
-  public fun getTimeout(): Long {
+  internal fun getTimeout(): Long {
     return timeoutUnits.toMillis(timeout)
   }
 
   /** Creates a new OkHttpClient with these options applied to it. */
-  public fun apply(client: OkHttpClient): OkHttpClient {
+  internal fun apply(client: OkHttpClient): OkHttpClient {
     return client
       .newBuilder()
       .callTimeout(timeout, timeoutUnits)

firebase-functions/src/main/java/com/google/firebase/functions/HttpsCallableOptions.kt

@@ -31,7 +31,7 @@ private constructor(
     return limitedUseAppCheckTokens
   }
 
-  /** Builder class for [com.google.firebase.functions.HttpsCallableOptions] */
+  /** A builder for creating [com.google.firebase.functions.HttpsCallableOptions]. */
   public class Builder {
     @JvmField public var limitedUseAppCheckTokens: Boolean = false
 

firebase-functions/src/main/java/com/google/firebase/functions/HttpsCallableReference.kt

@@ -32,7 +32,7 @@ public class HttpsCallableReference {
   private val url: URL?
 
   // Options for how to do the HTTPS call.
-  @VisibleForTesting public val options: HttpsCallOptions
+  @VisibleForTesting internal val options: HttpsCallOptions
 
   /** Creates a new reference with the given options. */
   internal constructor(
@@ -81,7 +81,7 @@ public class HttpsCallableReference {
    * Auth, an auth token for the user will also be automatically included.
    *
    * Firebase Instance ID sends data to the Firebase backend periodically to collect information
-   * regarding the app instance. To stop this, see [ ]
+   * regarding the app instance. To stop this, see
    * [com.google.firebase.iid.FirebaseInstanceId.deleteInstanceId]. It will resume with a new
    * Instance ID the next time you call this method.
    *
@@ -111,7 +111,7 @@ public class HttpsCallableReference {
    * Auth, an auth token for the user will also be automatically included.
    *
    * Firebase Instance ID sends data to the Firebase backend periodically to collect information
-   * regarding the app instance. To stop this, see [ ]
+   * regarding the app instance. To stop this, see
    * [com.google.firebase.iid.FirebaseInstanceId.deleteInstanceId]. It will resume with a new
    * Instance ID the next time you call this method.
    *

firebase-functions/src/main/java/com/google/firebase/functions/HttpsCallableResult.kt

@@ -13,16 +13,16 @@
 // limitations under the License.
 package com.google.firebase.functions
 
-/** The result of calling a HttpsCallableReference function. */
+/** The result of calling a `HttpsCallableReference` function. */
 public class HttpsCallableResult
 internal constructor( // The actual result data, as generic types decoded from JSON.
 private val data: Any?) {
   /**
    * Returns the data that was returned from the Callable HTTPS trigger.
    *
    * The data is in the form of native Java objects. For example, if your trigger returned an array,
-   * this object would be a List<Object>. If your trigger returned a JavaScript object with keys and
-   * values, this object would be a Map<String, Object>.
+   * this object would be a `List<Object>`. If your trigger returned a JavaScript object with keys and
+   * values, this object would be a `Map<String, Object>`.
    */
   public fun getData(): Any? {
     return data

firebase-functions/src/main/java/com/google/firebase/functions/Serializer.kt

@@ -23,7 +23,7 @@ import org.json.JSONException
 import org.json.JSONObject
 
 /** Converts raw Java types into JSON objects. */
-public class Serializer {
+internal class Serializer {
   private val dateFormat: DateFormat
 
   init {
@@ -32,7 +32,7 @@ public class Serializer {
     dateFormat.timeZone = TimeZone.getTimeZone("UTC")
   }
 
-  public fun encode(obj: Any?): Any {
+  internal fun encode(obj: Any?): Any {
     if (obj == null || obj === JSONObject.NULL) {
       return JSONObject.NULL
     }
@@ -113,7 +113,7 @@ public class Serializer {
     throw IllegalArgumentException("Object cannot be encoded in JSON: $obj")
   }
 
-  public fun decode(obj: Any): Any? {
+  internal fun decode(obj: Any): Any? {
     // TODO: Maybe this should throw a FirebaseFunctionsException instead?
     if (obj is Number) {
       return obj
@@ -170,11 +170,11 @@ public class Serializer {
     throw IllegalArgumentException("Object cannot be decoded from JSON: $obj")
   }
 
-  public companion object {
+  internal companion object {
     @VisibleForTesting
-    public const val LONG_TYPE: String = "type.googleapis.com/google.protobuf.Int64Value"
+    internal const val LONG_TYPE: String = "type.googleapis.com/google.protobuf.Int64Value"
 
     @VisibleForTesting
-    public const val UNSIGNED_LONG_TYPE: String = "type.googleapis.com/google.protobuf.UInt64Value"
+    internal const val UNSIGNED_LONG_TYPE: String = "type.googleapis.com/google.protobuf.UInt64Value"
   }
 }