Skip to content

Javadoc fixes #5019

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 20, 2023
Merged

Javadoc fixes #5019

merged 3 commits into from
May 20, 2023

Conversation

rosalyntan
Copy link
Member

Javadoc fixes in App Check and Functions.

@github-actions
Copy link
Contributor

github-actions bot commented May 19, 2023

Javadoc Changes:
--- /Users/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/appcheck/FirebaseAppCheck.html	2023-05-19 23:19:45.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/appcheck/FirebaseAppCheck.html	2023-05-19 23:14:43.000000000 +0000
@@ -197,7 +197,7 @@
         <h3 class="api-name" id="getAppCheckToken(boolean)">getAppCheckToken</h3>
         <pre class="api-signature no-pretty-print">public&nbsp;abstract&nbsp;@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developers.google.com/android/reference/com/google/android/gms/tasks/Task.html">Task</a>&lt;<a href="/docs/reference/android/com/google/firebase/appcheck/AppCheckToken.html">AppCheckToken</a>&gt;&nbsp;<a href="/docs/reference/android/com/google/firebase/appcheck/FirebaseAppCheck.html#getAppCheckToken(boolean)">getAppCheckToken</a>(boolean&nbsp;forceRefresh)</pre>
         <p>Requests a Firebase App Check token. This method should be used ONLY if you need to authorize requests to a non-Firebase backend. Requests to Firebase backends are authorized automatically if configured. </p>
-        <p>If your non-Firebase backend exposes sensitive or expensive endpoints that has low traffic volume, consider protecting it with <a href="https://firebase.google.com/docs/app-check/custom-resource-backend#replay-protection">Replay Protection</a>. In this case, use the #getLimitedUseAppCheckToken() instead to obtain a limited-use token.</p>
+        <p>If your non-Firebase backend exposes a sensitive or expensive endpoint that has low traffic volume, consider protecting it with <a href="https://firebase.google.com/docs/app-check/custom-resource-backend#replay-protection">Replay Protection</a>. In this case, use <code><a href="/docs/reference/android/com/google/firebase/appcheck/FirebaseAppCheck.html#getLimitedUseAppCheckToken()">getLimitedUseAppCheckToken</a></code> instead to obtain a limited-use token.</p>
       </div>
       <div class="api-item"><a name="getInstance--"></a><a name="getinstance"></a>
         <h3 class="api-name" id="getInstance()">getInstance</h3>
@@ -213,7 +213,7 @@
         <h3 class="api-name" id="getLimitedUseAppCheckToken()">getLimitedUseAppCheckToken</h3>
         <pre class="api-signature no-pretty-print">public&nbsp;abstract&nbsp;@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developers.google.com/android/reference/com/google/android/gms/tasks/Task.html">Task</a>&lt;<a href="/docs/reference/android/com/google/firebase/appcheck/AppCheckToken.html">AppCheckToken</a>&gt;&nbsp;<a href="/docs/reference/android/com/google/firebase/appcheck/FirebaseAppCheck.html#getLimitedUseAppCheckToken()">getLimitedUseAppCheckToken</a>()</pre>
         <p>Requests a Firebase App Check token. This method should be used ONLY if you need to authorize requests to a non-Firebase backend. </p>
-        <p>Returns limited-use tokens that are intended for use with your non-Firebase backend endpoints that are protected with <a href="https://firebase.google.com/docs/app-check/custom-resource-backend#replay-protection">Replay Protection</a>. This method does not affect the token generation behavior of the #getAppCheckToken() method.</p>
+        <p>Returns limited-use tokens that are intended for use with your non-Firebase backend endpoints that are protected with <a href="https://firebase.google.com/docs/app-check/custom-resource-backend#replay-protection">Replay Protection</a>. This method does not affect the token generation behavior of the <code><a href="/docs/reference/android/com/google/firebase/appcheck/FirebaseAppCheck.html#getAppCheckToken(boolean)">getAppCheckToken</a></code> method.</p>
       </div>
       <div class="api-item"><a name="installAppCheckProviderFactory-com.google.firebase.appcheck.AppCheckProviderFactory-"></a><a name="installappcheckproviderfactory"></a>
         <h3 class="api-name" id="installAppCheckProviderFactory(com.google.firebase.appcheck.AppCheckProviderFactory)">installAppCheckProviderFactory</h3>
--- /Users/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/functions/FirebaseFunctions.html	2023-05-19 23:18:26.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/functions/FirebaseFunctions.html	2023-05-19 23:12:39.000000000 +0000
@@ -29,28 +29,28 @@
             <td><code>@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/functions/HttpsCallableReference.html">HttpsCallableReference</a></code></td>
             <td>
               <div><code><a href="/docs/reference/android/com/google/firebase/functions/FirebaseFunctions.html#getHttpsCallable(java.lang.String)">getHttpsCallable</a>(@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a>&nbsp;name)</code></div>
-              <p>Returns a reference to the Callable HTTPS trigger with the given name.</p>
+              <p>Returns a reference to the callable HTTPS trigger with the given name.</p>
             </td>
           </tr>
           <tr>
             <td><code>@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/functions/HttpsCallableReference.html">HttpsCallableReference</a></code></td>
             <td>
               <div><code><a href="/docs/reference/android/com/google/firebase/functions/FirebaseFunctions.html#getHttpsCallable(java.lang.String,com.google.firebase.functions.HttpsCallableOptions)">getHttpsCallable</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a>&nbsp;name,<br>&nbsp;&nbsp;&nbsp;&nbsp;@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/functions/HttpsCallableOptions.html">HttpsCallableOptions</a>&nbsp;options<br>)</code></div>
-              <p>Returns a reference to the Callable HTTPS trigger with the given name and call options.</p>
+              <p>Returns a reference to the callable HTTPS trigger with the given name and call options.</p>
             </td>
           </tr>
           <tr>
             <td><code>@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/functions/HttpsCallableReference.html">HttpsCallableReference</a></code></td>
             <td>
               <div><code><a href="/docs/reference/android/com/google/firebase/functions/FirebaseFunctions.html#getHttpsCallableFromUrl(java.net.URL)">getHttpsCallableFromUrl</a>(@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/net/URL.html">URL</a>&nbsp;url)</code></div>
-              <p>Returns a reference to the Callable HTTPS trigger with the provided url.</p>
+              <p>Returns a reference to the callable HTTPS trigger with the provided URL.</p>
             </td>
           </tr>
           <tr>
             <td><code>@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/functions/HttpsCallableReference.html">HttpsCallableReference</a></code></td>
             <td>
               <div><code><a href="/docs/reference/android/com/google/firebase/functions/FirebaseFunctions.html#getHttpsCallableFromUrl(java.net.URL,com.google.firebase.functions.HttpsCallableOptions)">getHttpsCallableFromUrl</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/net/URL.html">URL</a>&nbsp;url,<br>&nbsp;&nbsp;&nbsp;&nbsp;@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/functions/HttpsCallableOptions.html">HttpsCallableOptions</a>&nbsp;options<br>)</code></div>
-              <p>Returns a reference to the Callable HTTPS trigger with the provided url and call options.</p>
+              <p>Returns a reference to the callable HTTPS trigger with the provided URL and call options.</p>
             </td>
           </tr>
           <tr>
@@ -105,22 +105,22 @@
       <div class="api-item"><a name="getHttpsCallable-java.lang.String-"></a><a name="gethttpscallable"></a>
         <h3 class="api-name" id="getHttpsCallable(java.lang.String)">getHttpsCallable</h3>
         <pre class="api-signature no-pretty-print">public&nbsp;@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/functions/HttpsCallableReference.html">HttpsCallableReference</a>&nbsp;<a href="/docs/reference/android/com/google/firebase/functions/FirebaseFunctions.html#getHttpsCallable(java.lang.String)">getHttpsCallable</a>(@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a>&nbsp;name)</pre>
-        <p>Returns a reference to the Callable HTTPS trigger with the given name.</p>
+        <p>Returns a reference to the callable HTTPS trigger with the given name.</p>
       </div>
       <div class="api-item"><a name="getHttpsCallable(java.lang.String, com.google.firebase.functions.HttpsCallableOptions)"></a><a name="getHttpsCallable-java.lang.String-com.google.firebase.functions.HttpsCallableOptions-"></a><a name="gethttpscallable"></a>
         <h3 class="api-name" id="getHttpsCallable(java.lang.String,com.google.firebase.functions.HttpsCallableOptions)">getHttpsCallable</h3>
         <pre class="api-signature no-pretty-print">public&nbsp;@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/functions/HttpsCallableReference.html">HttpsCallableReference</a>&nbsp;<a href="/docs/reference/android/com/google/firebase/functions/FirebaseFunctions.html#getHttpsCallable(java.lang.String,com.google.firebase.functions.HttpsCallableOptions)">getHttpsCallable</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a>&nbsp;name,<br>&nbsp;&nbsp;&nbsp;&nbsp;@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/functions/HttpsCallableOptions.html">HttpsCallableOptions</a>&nbsp;options<br>)</pre>
-        <p>Returns a reference to the Callable HTTPS trigger with the given name and call options.</p>
+        <p>Returns a reference to the callable HTTPS trigger with the given name and call options.</p>
       </div>
       <div class="api-item"><a name="getHttpsCallableFromUrl-java.net.URL-"></a><a name="gethttpscallablefromurl"></a>
         <h3 class="api-name" id="getHttpsCallableFromUrl(java.net.URL)">getHttpsCallableFromUrl</h3>
         <pre class="api-signature no-pretty-print">public&nbsp;@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/functions/HttpsCallableReference.html">HttpsCallableReference</a>&nbsp;<a href="/docs/reference/android/com/google/firebase/functions/FirebaseFunctions.html#getHttpsCallableFromUrl(java.net.URL)">getHttpsCallableFromUrl</a>(@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/net/URL.html">URL</a>&nbsp;url)</pre>
-        <p>Returns a reference to the Callable HTTPS trigger with the provided url.</p>
+        <p>Returns a reference to the callable HTTPS trigger with the provided URL.</p>
       </div>
       <div class="api-item"><a name="getHttpsCallableFromUrl(java.net.URL, com.google.firebase.functions.HttpsCallableOptions)"></a><a name="getHttpsCallableFromUrl-java.net.URL-com.google.firebase.functions.HttpsCallableOptions-"></a><a name="gethttpscallablefromurl"></a>
         <h3 class="api-name" id="getHttpsCallableFromUrl(java.net.URL,com.google.firebase.functions.HttpsCallableOptions)">getHttpsCallableFromUrl</h3>
         <pre class="api-signature no-pretty-print">public&nbsp;@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/functions/HttpsCallableReference.html">HttpsCallableReference</a>&nbsp;<a href="/docs/reference/android/com/google/firebase/functions/FirebaseFunctions.html#getHttpsCallableFromUrl(java.net.URL,com.google.firebase.functions.HttpsCallableOptions)">getHttpsCallableFromUrl</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/net/URL.html">URL</a>&nbsp;url,<br>&nbsp;&nbsp;&nbsp;&nbsp;@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/functions/HttpsCallableOptions.html">HttpsCallableOptions</a>&nbsp;options<br>)</pre>
-        <p>Returns a reference to the Callable HTTPS trigger with the provided url and call options.</p>
+        <p>Returns a reference to the callable HTTPS trigger with the provided URL and call options.</p>
       </div>
       <div class="api-item"><a name="getInstance--"></a><a name="getinstance"></a>
         <h3 class="api-name" id="getInstance()">getInstance</h3>
--- /Users/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/appcheck/FirebaseAppCheck.html	2023-05-19 23:19:45.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/appcheck/FirebaseAppCheck.html	2023-05-19 23:14:43.000000000 +0000
@@ -197,7 +197,7 @@
         <h3 class="api-name" id="getAppCheckToken(boolean)">getAppCheckToken</h3>
         <pre class="api-signature no-pretty-print">abstract&nbsp;fun&nbsp;<a href="/docs/reference/kotlin/com/google/firebase/appcheck/FirebaseAppCheck.html#getAppCheckToken(boolean)">getAppCheckToken</a>(forceRefresh:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a>):&nbsp;<a href="https://developers.google.com/android/reference/com/google/android/gms/tasks/Task.html">Task</a>&lt;<a href="/docs/reference/kotlin/com/google/firebase/appcheck/AppCheckToken.html">AppCheckToken</a>!&gt;</pre>
         <p>Requests a Firebase App Check token. This method should be used ONLY if you need to authorize requests to a non-Firebase backend. Requests to Firebase backends are authorized automatically if configured. </p>
-        <p>If your non-Firebase backend exposes sensitive or expensive endpoints that has low traffic volume, consider protecting it with <a href="https://firebase.google.com/docs/app-check/custom-resource-backend#replay-protection">Replay Protection</a>. In this case, use the #getLimitedUseAppCheckToken() instead to obtain a limited-use token.</p>
+        <p>If your non-Firebase backend exposes a sensitive or expensive endpoint that has low traffic volume, consider protecting it with <a href="https://firebase.google.com/docs/app-check/custom-resource-backend#replay-protection">Replay Protection</a>. In this case, use <code><a href="/docs/reference/kotlin/com/google/firebase/appcheck/FirebaseAppCheck.html#getLimitedUseAppCheckToken()">getLimitedUseAppCheckToken</a></code> instead to obtain a limited-use token.</p>
       </div>
       <div class="api-item"><a name="getInstance--"></a><a name="getinstance"></a>
         <h3 class="api-name" id="getInstance()">getInstance</h3>
@@ -213,7 +213,7 @@
         <h3 class="api-name" id="getLimitedUseAppCheckToken()">getLimitedUseAppCheckToken</h3>
         <pre class="api-signature no-pretty-print">abstract&nbsp;fun&nbsp;<a href="/docs/reference/kotlin/com/google/firebase/appcheck/FirebaseAppCheck.html#getLimitedUseAppCheckToken()">getLimitedUseAppCheckToken</a>():&nbsp;<a href="https://developers.google.com/android/reference/com/google/android/gms/tasks/Task.html">Task</a>&lt;<a href="/docs/reference/kotlin/com/google/firebase/appcheck/AppCheckToken.html">AppCheckToken</a>!&gt;</pre>
         <p>Requests a Firebase App Check token. This method should be used ONLY if you need to authorize requests to a non-Firebase backend. </p>
-        <p>Returns limited-use tokens that are intended for use with your non-Firebase backend endpoints that are protected with <a href="https://firebase.google.com/docs/app-check/custom-resource-backend#replay-protection">Replay Protection</a>. This method does not affect the token generation behavior of the #getAppCheckToken() method.</p>
+        <p>Returns limited-use tokens that are intended for use with your non-Firebase backend endpoints that are protected with <a href="https://firebase.google.com/docs/app-check/custom-resource-backend#replay-protection">Replay Protection</a>. This method does not affect the token generation behavior of the <code><a href="/docs/reference/kotlin/com/google/firebase/appcheck/FirebaseAppCheck.html#getAppCheckToken(boolean)">getAppCheckToken</a></code> method.</p>
       </div>
       <div class="api-item"><a name="installAppCheckProviderFactory-com.google.firebase.appcheck.AppCheckProviderFactory-"></a><a name="installappcheckproviderfactory"></a>
         <h3 class="api-name" id="installAppCheckProviderFactory(com.google.firebase.appcheck.AppCheckProviderFactory)">installAppCheckProviderFactory</h3>
--- /Users/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/functions/FirebaseFunctions.html	2023-05-19 23:18:26.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/functions/FirebaseFunctions.html	2023-05-19 23:12:39.000000000 +0000
@@ -29,28 +29,28 @@
             <td><code><a href="/docs/reference/kotlin/com/google/firebase/functions/HttpsCallableReference.html">HttpsCallableReference</a></code></td>
             <td>
               <div><code><a href="/docs/reference/kotlin/com/google/firebase/functions/FirebaseFunctions.html#getHttpsCallable(java.lang.String)">getHttpsCallable</a>(name:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>)</code></div>
-              <p>Returns a reference to the Callable HTTPS trigger with the given name.</p>
+              <p>Returns a reference to the callable HTTPS trigger with the given name.</p>
             </td>
           </tr>
           <tr>
             <td><code><a href="/docs/reference/kotlin/com/google/firebase/functions/HttpsCallableReference.html">HttpsCallableReference</a></code></td>
             <td>
               <div><code><a href="/docs/reference/kotlin/com/google/firebase/functions/FirebaseFunctions.html#getHttpsCallable(java.lang.String,com.google.firebase.functions.HttpsCallableOptions)">getHttpsCallable</a>(name:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>,&nbsp;options:&nbsp;<a href="/docs/reference/kotlin/com/google/firebase/functions/HttpsCallableOptions.html">HttpsCallableOptions</a>)</code></div>
-              <p>Returns a reference to the Callable HTTPS trigger with the given name and call options.</p>
+              <p>Returns a reference to the callable HTTPS trigger with the given name and call options.</p>
             </td>
           </tr>
           <tr>
             <td><code><a href="/docs/reference/kotlin/com/google/firebase/functions/HttpsCallableReference.html">HttpsCallableReference</a></code></td>
             <td>
               <div><code><a href="/docs/reference/kotlin/com/google/firebase/functions/FirebaseFunctions.html#getHttpsCallableFromUrl(java.net.URL)">getHttpsCallableFromUrl</a>(url:&nbsp;<a href="https://developer.android.com/reference/kotlin/java/net/URL.html">URL</a>)</code></div>
-              <p>Returns a reference to the Callable HTTPS trigger with the provided url.</p>
+              <p>Returns a reference to the callable HTTPS trigger with the provided URL.</p>
             </td>
           </tr>
           <tr>
             <td><code><a href="/docs/reference/kotlin/com/google/firebase/functions/HttpsCallableReference.html">HttpsCallableReference</a></code></td>
             <td>
               <div><code><a href="/docs/reference/kotlin/com/google/firebase/functions/FirebaseFunctions.html#getHttpsCallableFromUrl(java.net.URL,com.google.firebase.functions.HttpsCallableOptions)">getHttpsCallableFromUrl</a>(url:&nbsp;<a href="https://developer.android.com/reference/kotlin/java/net/URL.html">URL</a>,&nbsp;options:&nbsp;<a href="/docs/reference/kotlin/com/google/firebase/functions/HttpsCallableOptions.html">HttpsCallableOptions</a>)</code></div>
-              <p>Returns a reference to the Callable HTTPS trigger with the provided url and call options.</p>
+              <p>Returns a reference to the callable HTTPS trigger with the provided URL and call options.</p>
             </td>
           </tr>
           <tr>
@@ -105,22 +105,22 @@
       <div class="api-item"><a name="getHttpsCallable-java.lang.String-"></a><a name="gethttpscallable"></a>
         <h3 class="api-name" id="getHttpsCallable(java.lang.String)">getHttpsCallable</h3>
         <pre class="api-signature no-pretty-print">fun&nbsp;<a href="/docs/reference/kotlin/com/google/firebase/functions/FirebaseFunctions.html#getHttpsCallable(java.lang.String)">getHttpsCallable</a>(name:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>):&nbsp;<a href="/docs/reference/kotlin/com/google/firebase/functions/HttpsCallableReference.html">HttpsCallableReference</a></pre>
-        <p>Returns a reference to the Callable HTTPS trigger with the given name.</p>
+        <p>Returns a reference to the callable HTTPS trigger with the given name.</p>
       </div>
       <div class="api-item"><a name="getHttpsCallable(java.lang.String, com.google.firebase.functions.HttpsCallableOptions)"></a><a name="getHttpsCallable-java.lang.String-com.google.firebase.functions.HttpsCallableOptions-"></a><a name="gethttpscallable"></a>
         <h3 class="api-name" id="getHttpsCallable(java.lang.String,com.google.firebase.functions.HttpsCallableOptions)">getHttpsCallable</h3>
         <pre class="api-signature no-pretty-print">fun&nbsp;<a href="/docs/reference/kotlin/com/google/firebase/functions/FirebaseFunctions.html#getHttpsCallable(java.lang.String,com.google.firebase.functions.HttpsCallableOptions)">getHttpsCallable</a>(name:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>,&nbsp;options:&nbsp;<a href="/docs/reference/kotlin/com/google/firebase/functions/HttpsCallableOptions.html">HttpsCallableOptions</a>):&nbsp;<a href="/docs/reference/kotlin/com/google/firebase/functions/HttpsCallableReference.html">HttpsCallableReference</a></pre>
-        <p>Returns a reference to the Callable HTTPS trigger with the given name and call options.</p>
+        <p>Returns a reference to the callable HTTPS trigger with the given name and call options.</p>
       </div>
       <div class="api-item"><a name="getHttpsCallableFromUrl-java.net.URL-"></a><a name="gethttpscallablefromurl"></a>
         <h3 class="api-name" id="getHttpsCallableFromUrl(java.net.URL)">getHttpsCallableFromUrl</h3>
         <pre class="api-signature no-pretty-print">fun&nbsp;<a href="/docs/reference/kotlin/com/google/firebase/functions/FirebaseFunctions.html#getHttpsCallableFromUrl(java.net.URL)">getHttpsCallableFromUrl</a>(url:&nbsp;<a href="https://developer.android.com/reference/kotlin/java/net/URL.html">URL</a>):&nbsp;<a href="/docs/reference/kotlin/com/google/firebase/functions/HttpsCallableReference.html">HttpsCallableReference</a></pre>
-        <p>Returns a reference to the Callable HTTPS trigger with the provided url.</p>
+        <p>Returns a reference to the callable HTTPS trigger with the provided URL.</p>
       </div>
       <div class="api-item"><a name="getHttpsCallableFromUrl(java.net.URL, com.google.firebase.functions.HttpsCallableOptions)"></a><a name="getHttpsCallableFromUrl-java.net.URL-com.google.firebase.functions.HttpsCallableOptions-"></a><a name="gethttpscallablefromurl"></a>
         <h3 class="api-name" id="getHttpsCallableFromUrl(java.net.URL,com.google.firebase.functions.HttpsCallableOptions)">getHttpsCallableFromUrl</h3>
         <pre class="api-signature no-pretty-print">fun&nbsp;<a href="/docs/reference/kotlin/com/google/firebase/functions/FirebaseFunctions.html#getHttpsCallableFromUrl(java.net.URL,com.google.firebase.functions.HttpsCallableOptions)">getHttpsCallableFromUrl</a>(url:&nbsp;<a href="https://developer.android.com/reference/kotlin/java/net/URL.html">URL</a>,&nbsp;options:&nbsp;<a href="/docs/reference/kotlin/com/google/firebase/functions/HttpsCallableOptions.html">HttpsCallableOptions</a>):&nbsp;<a href="/docs/reference/kotlin/com/google/firebase/functions/HttpsCallableReference.html">HttpsCallableReference</a></pre>
-        <p>Returns a reference to the Callable HTTPS trigger with the provided url and call options.</p>
+        <p>Returns a reference to the callable HTTPS trigger with the provided URL and call options.</p>
       </div>
       <div class="api-item"><a name="getInstance--"></a><a name="getinstance"></a>
         <h3 class="api-name" id="getInstance()">getInstance</h3>

@google-oss-bot
Copy link
Contributor

1 Warning
⚠️ Did you forget to add a changelog entry? (Add the 'no-changelog' label to the PR to silence this warning.)

Generated by 🚫 Danger

@rosalyntan rosalyntan marked this pull request as ready for review May 19, 2023 23:02
@rosalyntan rosalyntan requested a review from rlazo May 19, 2023 23:02
@rosalyntan
Copy link
Member Author

@rlazo does this need a changelog? (i.e. should these Javadoc fixes trigger the SDK to be released if there are no other changes that go in?)

@google-oss-bot
Copy link
Contributor

@github-actions
Copy link
Contributor

Unit Test Results

  96 files  +  96    96 suites  +96   8m 20s ⏱️ + 8m 20s
255 tests +255  255 ✔️ +255  0 💤 ±0  0 ±0 
510 runs  +510  510 ✔️ +510  0 💤 ±0  0 ±0 

Results for commit e79a41d. ± Comparison against base commit 28e3a68.

@google-oss-bot
Copy link
Contributor

@google-oss-bot
Copy link
Contributor

Startup Time Report 1

Note: Layout is sometimes suboptimal due to limited formatting support on GitHub. Please check this report on GCS.

Notes

Startup Times

  • fire-app-check

    DeviceStatisticsDistributions
    oriole-32
    Percentile28e3a685f5f0ccDiffSignificant (?)
    p10689 ±943 μs661 ±915 μs-28.4 μs (-4.1%)NO
    p25720 ±975 μs700 ±941 μs-19.9 μs (-2.8%)NO
    p50791 ±1042 μs771 ±1000 μs-19.6 μs (-2.5%)NO
    p75911 ±1192 μs934 ±1198 μs+23.5 μs (+2.6%)NO
    p901.05 ±1 ms1.15 ±1 ms+92.8 μs (+8.8%)NO

    20 test runs in comparison
    CommitTest Runs
    28e3a68
    • 2023-05-18_22:01:19.853743_NHfy
    • 2023-05-18_22:01:19.857066_lVoV
    • 2023-05-18_22:01:19.857092_ibKd
    • 2023-05-18_22:01:19.857103_ksmU
    • 2023-05-18_22:01:19.857110_dFdp
    • 2023-05-18_22:01:19.857117_Tpru
    • 2023-05-18_22:01:19.857124_ZEDY
    • 2023-05-18_22:01:19.857131_LMan
    • 2023-05-18_22:01:19.857138_SIlx
    • 2023-05-18_22:01:19.857145_rWkG
    5f5f0cc
    • 2023-05-19_23:18:34.874406_WAGv
    • 2023-05-19_23:18:34.876673_TEsq
    • 2023-05-19_23:18:34.876686_Tlut
    • 2023-05-19_23:18:34.876693_HHfT
    • 2023-05-19_23:18:34.876699_FWgl
    • 2023-05-19_23:18:34.876705_vwcA
    • 2023-05-19_23:18:34.876711_SNTJ
    • 2023-05-19_23:18:34.876717_LAKF
    • 2023-05-19_23:18:34.876723_bVXN
    • 2023-05-19_23:18:34.876730_FwQF
    redfin-30
    Percentile28e3a685f5f0ccDiffSignificant (?)
    p101.74 ±2 ms443 ±116 μs-1.29 ms (-74.5%)NO
    p251.91 ±2 ms485 ±153 μs-1.42 ms (-74.6%)NO
    p502.15 ±3 ms570 ±270 μs-1.58 ms (-73.4%)NO
    p752.51 ±3 ms734 ±456 μs-1.78 ms (-70.7%)NO
    p902.88 ±3 ms1.05 ±0.8 ms-1.83 ms (-63.7%)NO

    20 test runs in comparison
    CommitTest Runs
    28e3a68
    • 2023-05-18_22:01:19.853743_NHfy
    • 2023-05-18_22:01:19.857066_lVoV
    • 2023-05-18_22:01:19.857092_ibKd
    • 2023-05-18_22:01:19.857103_ksmU
    • 2023-05-18_22:01:19.857110_dFdp
    • 2023-05-18_22:01:19.857117_Tpru
    • 2023-05-18_22:01:19.857124_ZEDY
    • 2023-05-18_22:01:19.857131_LMan
    • 2023-05-18_22:01:19.857138_SIlx
    • 2023-05-18_22:01:19.857145_rWkG
    5f5f0cc
    • 2023-05-19_23:18:34.874406_WAGv
    • 2023-05-19_23:18:34.876673_TEsq
    • 2023-05-19_23:18:34.876686_Tlut
    • 2023-05-19_23:18:34.876693_HHfT
    • 2023-05-19_23:18:34.876699_FWgl
    • 2023-05-19_23:18:34.876705_vwcA
    • 2023-05-19_23:18:34.876711_SNTJ
    • 2023-05-19_23:18:34.876717_LAKF
    • 2023-05-19_23:18:34.876723_bVXN
    • 2023-05-19_23:18:34.876730_FwQF
  • fire-fn

    DeviceStatisticsDistributions
    oriole-32
    Percentile28e3a685f5f0ccDiffSignificant (?)
    p1071.1 ±11 μs67.5 ±8 μs-3.55 μs (-5.0%)NO
    p2576.1 ±13 μs72.6 ±10 μs-3.51 μs (-4.6%)NO
    p5085.5 ±19 μs82.4 ±19 μs-3.16 μs (-3.7%)NO
    p75100 ±29 μs100 ±28 μs+29.6 ns (+0.0%)NO
    p90131 ±52 μs122 ±44 μs-8.59 μs (-6.6%)NO

    20 test runs in comparison
    CommitTest Runs
    28e3a68
    • 2023-05-18_22:01:19.853743_NHfy
    • 2023-05-18_22:01:19.857066_lVoV
    • 2023-05-18_22:01:19.857092_ibKd
    • 2023-05-18_22:01:19.857103_ksmU
    • 2023-05-18_22:01:19.857110_dFdp
    • 2023-05-18_22:01:19.857117_Tpru
    • 2023-05-18_22:01:19.857124_ZEDY
    • 2023-05-18_22:01:19.857131_LMan
    • 2023-05-18_22:01:19.857138_SIlx
    • 2023-05-18_22:01:19.857145_rWkG
    5f5f0cc
    • 2023-05-19_23:18:34.874406_WAGv
    • 2023-05-19_23:18:34.876673_TEsq
    • 2023-05-19_23:18:34.876686_Tlut
    • 2023-05-19_23:18:34.876693_HHfT
    • 2023-05-19_23:18:34.876699_FWgl
    • 2023-05-19_23:18:34.876705_vwcA
    • 2023-05-19_23:18:34.876711_SNTJ
    • 2023-05-19_23:18:34.876717_LAKF
    • 2023-05-19_23:18:34.876723_bVXN
    • 2023-05-19_23:18:34.876730_FwQF
    redfin-30
    Percentile28e3a685f5f0ccDiffSignificant (?)
    p10137 ±17 μs143 ±16 μs+6.03 μs (+4.4%)NO
    p25144 ±17 μs150 ±18 μs+5.98 μs (+4.1%)NO
    p50154 ±19 μs162 ±19 μs+8.03 μs (+5.2%)NO
    p75169 ±22 μs176 ±24 μs+6.92 μs (+4.1%)NO
    p90192 ±30 μs196 ±33 μs+4.10 μs (+2.1%)NO

    20 test runs in comparison
    CommitTest Runs
    28e3a68
    • 2023-05-18_22:01:19.853743_NHfy
    • 2023-05-18_22:01:19.857066_lVoV
    • 2023-05-18_22:01:19.857092_ibKd
    • 2023-05-18_22:01:19.857103_ksmU
    • 2023-05-18_22:01:19.857110_dFdp
    • 2023-05-18_22:01:19.857117_Tpru
    • 2023-05-18_22:01:19.857124_ZEDY
    • 2023-05-18_22:01:19.857131_LMan
    • 2023-05-18_22:01:19.857138_SIlx
    • 2023-05-18_22:01:19.857145_rWkG
    5f5f0cc
    • 2023-05-19_23:18:34.874406_WAGv
    • 2023-05-19_23:18:34.876673_TEsq
    • 2023-05-19_23:18:34.876686_Tlut
    • 2023-05-19_23:18:34.876693_HHfT
    • 2023-05-19_23:18:34.876699_FWgl
    • 2023-05-19_23:18:34.876705_vwcA
    • 2023-05-19_23:18:34.876711_SNTJ
    • 2023-05-19_23:18:34.876717_LAKF
    • 2023-05-19_23:18:34.876723_bVXN
    • 2023-05-19_23:18:34.876730_FwQF
  • fire-gcs

    DeviceStatisticsDistributions
    oriole-32
    Percentile28e3a685f5f0ccDiffSignificant (?)
    p1035.4 ±5 μs37.0 ±5 μs+1.63 μs (+4.6%)NO
    p2537.1 ±6 μs39.6 ±6 μs+2.52 μs (+6.8%)NO
    p5039.9 ±6 μs43.9 ±8 μs+3.93 μs (+9.8%)NO
    p7546.5 ±9 μs52.0 ±12 μs+5.45 μs (+11.7%)NO
    p9056.0 ±16 μs65.6 ±22 μs+9.56 μs (+17.1%)NO

    20 test runs in comparison
    CommitTest Runs
    28e3a68
    • 2023-05-18_22:01:19.853743_NHfy
    • 2023-05-18_22:01:19.857066_lVoV
    • 2023-05-18_22:01:19.857092_ibKd
    • 2023-05-18_22:01:19.857103_ksmU
    • 2023-05-18_22:01:19.857110_dFdp
    • 2023-05-18_22:01:19.857117_Tpru
    • 2023-05-18_22:01:19.857124_ZEDY
    • 2023-05-18_22:01:19.857131_LMan
    • 2023-05-18_22:01:19.857138_SIlx
    • 2023-05-18_22:01:19.857145_rWkG
    5f5f0cc
    • 2023-05-19_23:18:34.874406_WAGv
    • 2023-05-19_23:18:34.876673_TEsq
    • 2023-05-19_23:18:34.876686_Tlut
    • 2023-05-19_23:18:34.876693_HHfT
    • 2023-05-19_23:18:34.876699_FWgl
    • 2023-05-19_23:18:34.876705_vwcA
    • 2023-05-19_23:18:34.876711_SNTJ
    • 2023-05-19_23:18:34.876717_LAKF
    • 2023-05-19_23:18:34.876723_bVXN
    • 2023-05-19_23:18:34.876730_FwQF
    redfin-30
    Percentile28e3a685f5f0ccDiffSignificant (?)
    p1084.0 ±11 μs93.6 ±15 μs+9.57 μs (+11.4%)NO
    p2588.2 ±12 μs98.4 ±15 μs+10.2 μs (+11.6%)NO
    p5095.5 ±14 μs106 ±18 μs+10.4 μs (+10.8%)NO
    p75106 ±17 μs120 ±23 μs+14.0 μs (+13.2%)NO
    p90123 ±29 μs137 ±29 μs+13.9 μs (+11.3%)NO

    20 test runs in comparison
    CommitTest Runs
    28e3a68
    • 2023-05-18_22:01:19.853743_NHfy
    • 2023-05-18_22:01:19.857066_lVoV
    • 2023-05-18_22:01:19.857092_ibKd
    • 2023-05-18_22:01:19.857103_ksmU
    • 2023-05-18_22:01:19.857110_dFdp
    • 2023-05-18_22:01:19.857117_Tpru
    • 2023-05-18_22:01:19.857124_ZEDY
    • 2023-05-18_22:01:19.857131_LMan
    • 2023-05-18_22:01:19.857138_SIlx
    • 2023-05-18_22:01:19.857145_rWkG
    5f5f0cc
    • 2023-05-19_23:18:34.874406_WAGv
    • 2023-05-19_23:18:34.876673_TEsq
    • 2023-05-19_23:18:34.876686_Tlut
    • 2023-05-19_23:18:34.876693_HHfT
    • 2023-05-19_23:18:34.876699_FWgl
    • 2023-05-19_23:18:34.876705_vwcA
    • 2023-05-19_23:18:34.876711_SNTJ
    • 2023-05-19_23:18:34.876717_LAKF
    • 2023-05-19_23:18:34.876723_bVXN
    • 2023-05-19_23:18:34.876730_FwQF
  • timeToInitialDisplay

    DeviceStatisticsDistributions
    oriole-32
    Percentile28e3a685f5f0ccDiffSignificant (?)
    p10191 ±4 ms197 ±3 ms+6.34 ms (+3.3%)NO
    p25197 ±4 ms203 ±3 ms+6.54 ms (+3.3%)NO
    p50204 ±4 ms212 ±3 ms+7.40 ms (+3.6%)NO
    p75212 ±5 ms221 ±3 ms+8.81 ms (+4.2%)NO
    p90221 ±4 ms234 ±6 ms+13.3 ms (+6.0%)NO

    20 test runs in comparison
    CommitTest Runs
    28e3a68
    • 2023-05-18_22:01:19.853743_NHfy
    • 2023-05-18_22:01:19.857066_lVoV
    • 2023-05-18_22:01:19.857092_ibKd
    • 2023-05-18_22:01:19.857103_ksmU
    • 2023-05-18_22:01:19.857110_dFdp
    • 2023-05-18_22:01:19.857117_Tpru
    • 2023-05-18_22:01:19.857124_ZEDY
    • 2023-05-18_22:01:19.857131_LMan
    • 2023-05-18_22:01:19.857138_SIlx
    • 2023-05-18_22:01:19.857145_rWkG
    5f5f0cc
    • 2023-05-19_23:18:34.874406_WAGv
    • 2023-05-19_23:18:34.876673_TEsq
    • 2023-05-19_23:18:34.876686_Tlut
    • 2023-05-19_23:18:34.876693_HHfT
    • 2023-05-19_23:18:34.876699_FWgl
    • 2023-05-19_23:18:34.876705_vwcA
    • 2023-05-19_23:18:34.876711_SNTJ
    • 2023-05-19_23:18:34.876717_LAKF
    • 2023-05-19_23:18:34.876723_bVXN
    • 2023-05-19_23:18:34.876730_FwQF
    redfin-30
    Percentile28e3a685f5f0ccDiffSignificant (?)
    p10233 ±4 ms251 ±4 ms+18.4 ms (+7.9%)MAYBE
    p25239 ±5 ms257 ±5 ms+18.7 ms (+7.8%)MAYBE
    p50245 ±6 ms264 ±5 ms+18.9 ms (+7.7%)MAYBE
    p75253 ±6 ms274 ±6 ms+20.6 ms (+8.1%)MAYBE
    p90262 ±6 ms286 ±8 ms+23.8 ms (+9.1%)MAYBE

    20 test runs in comparison
    CommitTest Runs
    28e3a68
    • 2023-05-18_22:01:19.853743_NHfy
    • 2023-05-18_22:01:19.857066_lVoV
    • 2023-05-18_22:01:19.857092_ibKd
    • 2023-05-18_22:01:19.857103_ksmU
    • 2023-05-18_22:01:19.857110_dFdp
    • 2023-05-18_22:01:19.857117_Tpru
    • 2023-05-18_22:01:19.857124_ZEDY
    • 2023-05-18_22:01:19.857131_LMan
    • 2023-05-18_22:01:19.857138_SIlx
    • 2023-05-18_22:01:19.857145_rWkG
    5f5f0cc
    • 2023-05-19_23:18:34.874406_WAGv
    • 2023-05-19_23:18:34.876673_TEsq
    • 2023-05-19_23:18:34.876686_Tlut
    • 2023-05-19_23:18:34.876693_HHfT
    • 2023-05-19_23:18:34.876699_FWgl
    • 2023-05-19_23:18:34.876705_vwcA
    • 2023-05-19_23:18:34.876711_SNTJ
    • 2023-05-19_23:18:34.876717_LAKF
    • 2023-05-19_23:18:34.876723_bVXN
    • 2023-05-19_23:18:34.876730_FwQF

  1. https://storage.googleapis.com/firebase-sdk-metric-reports/jbMbad2ctv/index.html

@rlazo
Copy link
Collaborator

rlazo commented May 20, 2023

@rlazo does this need a changelog? (i.e. should these Javadoc fixes trigger the SDK to be released if there are no other changes that go in?)

Not really. We could potentially re-generate the javadocs available if we really want and update them without triggering a release. Alternatively, we could wait until the next time the SDK is released and have the updates published then.

@rlazo rlazo merged commit fa7a068 into master May 20, 2023
@rlazo rlazo deleted the rosalyntan.javadoc branch May 20, 2023 04:44
@firebase firebase locked and limited conversation to collaborators Jun 20, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants