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.

Sign up for GitHub

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bcbf64d
Javadoc fixes for App Check.
rosalyntan May 19, 2023
16e4602
Javadoc fixes for Functions.
rosalyntan May 19, 2023
e79a41d
One more Javadoc fix.
rosalyntan May 19, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions appcheck/firebase-appcheck/src/main/java/com/google/firebase/appcheck/FirebaseAppCheck.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,10 +76,10 @@ public abstract void installAppCheckProviderFactory(
* requests to a non-Firebase backend. Requests to Firebase backends are authorized automatically
* if configured.
*
* <p>If your non-Firebase backend exposes sensitive or expensive endpoints that has low traffic
* <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 the #getLimitedUseAppCheckToken() instead to obtain a
* Protection</a>. In this case, use {@link #getLimitedUseAppCheckToken()} instead to obtain a
* limited-use token.
*/
@NonNull
Expand All @@ -92,8 +92,8 @@ public abstract void installAppCheckProviderFactory(
* <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.
* Protection</a>. This method does not affect the token generation behavior of the {@link
* #getAppCheckToken(boolean forceRefresh)} method.
*/
@NonNull
public abstract Task<AppCheckToken> getLimitedUseAppCheckToken();
Expand Down
8 changes: 4 additions & 4 deletions firebase-functions/src/main/java/com/google/firebase/functions/FirebaseFunctions.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,26 +202,26 @@ public static FirebaseFunctions getInstance() {
return getInstance(FirebaseApp.getInstance(), "us-central1");
}

/** Returns a reference to the Callable HTTPS trigger with the given name. */
/** Returns a reference to the callable HTTPS trigger with the given name. */
@NonNull
public HttpsCallableReference getHttpsCallable(@NonNull String name) {
return new HttpsCallableReference(this, name, new HttpsCallOptions());
}

/** Returns a reference to the Callable HTTPS trigger with the provided url. */
/** Returns a reference to the callable HTTPS trigger with the provided URL. */
@NonNull
public HttpsCallableReference getHttpsCallableFromUrl(@NonNull URL url) {
return new HttpsCallableReference(this, url, new HttpsCallOptions());
}

/** Returns a reference to the Callable HTTPS trigger with the given name and call options. */
/** Returns a reference to the callable HTTPS trigger with the given name and call options. */
@NonNull
public HttpsCallableReference getHttpsCallable(
@NonNull String name, @NonNull HttpsCallableOptions options) {
return new HttpsCallableReference(this, name, new HttpsCallOptions(options));
}

/** Returns a reference to the Callable HTTPS trigger with the provided url and call options. */
/** Returns a reference to the callable HTTPS trigger with the provided URL and call options. */
@NonNull
public HttpsCallableReference getHttpsCallableFromUrl(
@NonNull URL url, @NonNull HttpsCallableOptions options) {
Expand Down