Skip to content

Commit fa7a068

Browse files
authored
Javadoc fixes (#5019)
* Javadoc fixes for App Check. * Javadoc fixes for Functions. * One more Javadoc fix.
1 parent 28e3a68 commit fa7a068

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

appcheck/firebase-appcheck/src/main/java/com/google/firebase/appcheck/FirebaseAppCheck.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -76,10 +76,10 @@ public abstract void installAppCheckProviderFactory(
7676
* requests to a non-Firebase backend. Requests to Firebase backends are authorized automatically
7777
* if configured.
7878
*
79-
* <p>If your non-Firebase backend exposes sensitive or expensive endpoints that has low traffic
79+
* <p>If your non-Firebase backend exposes a sensitive or expensive endpoint that has low traffic
8080
* volume, consider protecting it with <a
8181
* href=https://firebase.google.com/docs/app-check/custom-resource-backend#replay-protection>Replay
82-
* Protection</a>. In this case, use the #getLimitedUseAppCheckToken() instead to obtain a
82+
* Protection</a>. In this case, use {@link #getLimitedUseAppCheckToken()} instead to obtain a
8383
* limited-use token.
8484
*/
8585
@NonNull
@@ -92,8 +92,8 @@ public abstract void installAppCheckProviderFactory(
9292
* <p>Returns limited-use tokens that are intended for use with your non-Firebase backend
9393
* endpoints that are protected with <a
9494
* href=https://firebase.google.com/docs/app-check/custom-resource-backend#replay-protection>Replay
95-
* Protection</a>. This method does not affect the token generation behavior of the
96-
* #getAppCheckToken() method.
95+
* Protection</a>. This method does not affect the token generation behavior of the {@link
96+
* #getAppCheckToken(boolean forceRefresh)} method.
9797
*/
9898
@NonNull
9999
public abstract Task<AppCheckToken> getLimitedUseAppCheckToken();

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -202,26 +202,26 @@ public static FirebaseFunctions getInstance() {
202202
return getInstance(FirebaseApp.getInstance(), "us-central1");
203203
}
204204

205-
/** Returns a reference to the Callable HTTPS trigger with the given name. */
205+
/** Returns a reference to the callable HTTPS trigger with the given name. */
206206
@NonNull
207207
public HttpsCallableReference getHttpsCallable(@NonNull String name) {
208208
return new HttpsCallableReference(this, name, new HttpsCallOptions());
209209
}
210210

211-
/** Returns a reference to the Callable HTTPS trigger with the provided url. */
211+
/** Returns a reference to the callable HTTPS trigger with the provided URL. */
212212
@NonNull
213213
public HttpsCallableReference getHttpsCallableFromUrl(@NonNull URL url) {
214214
return new HttpsCallableReference(this, url, new HttpsCallOptions());
215215
}
216216

217-
/** Returns a reference to the Callable HTTPS trigger with the given name and call options. */
217+
/** Returns a reference to the callable HTTPS trigger with the given name and call options. */
218218
@NonNull
219219
public HttpsCallableReference getHttpsCallable(
220220
@NonNull String name, @NonNull HttpsCallableOptions options) {
221221
return new HttpsCallableReference(this, name, new HttpsCallOptions(options));
222222
}
223223

224-
/** Returns a reference to the Callable HTTPS trigger with the provided url and call options. */
224+
/** Returns a reference to the callable HTTPS trigger with the provided URL and call options. */
225225
@NonNull
226226
public HttpsCallableReference getHttpsCallableFromUrl(
227227
@NonNull URL url, @NonNull HttpsCallableOptions options) {

0 commit comments

Comments
 (0)