Skip to content

Commit 4cbb0b9

Browse files
authored
Some documentation updates (#240)
1 parent 222f9c3 commit 4cbb0b9

File tree

2 files changed

+13
-11
lines changed

2 files changed

+13
-11
lines changed

src/main/java/com/google/firebase/auth/ActionCodeSettings.java

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,9 @@ public static final class Builder {
9292
private Builder() { }
9393

9494
/**
95-
* Sets the link continue/state URL, which has different meanings in different contexts:
95+
* Sets the link continue/state URL.
96+
*
97+
* <p>This parameter has different meanings in different contexts:
9698
*
9799
* <ul>
98100
* <li>When the link is handled in the web action widgets, this is the deep link in the

src/main/java/com/google/firebase/auth/FirebaseAuth.java

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -988,9 +988,9 @@ public String generatePasswordResetLink(@NonNull String email) throws FirebaseAu
988988
* address.
989989
*
990990
* @param email The email of the user whose password is to be reset.
991-
* @param settings The action code settings which defines whether
991+
* @param settings The action code settings object which defines whether
992992
* the link is to be handled by a mobile app and the additional state information to be
993-
* passed in the deep link, etc.
993+
* passed in the deep link.
994994
* @return A password reset link.
995995
* @throws IllegalArgumentException If the email address is null or empty.
996996
* @throws FirebaseAuthException If an error occurs while generating the link.
@@ -1019,9 +1019,9 @@ public ApiFuture<String> generatePasswordResetLinkAsync(@NonNull String email) {
10191019
* operation asynchronously.
10201020
*
10211021
* @param email The email of the user whose password is to be reset.
1022-
* @param settings The action code settings which defines whether
1022+
* @param settings The action code settings object which defines whether
10231023
* the link is to be handled by a mobile app and the additional state information to be
1024-
* passed in the deep link, etc.
1024+
* passed in the deep link.
10251025
* @return An {@code ApiFuture} which will complete successfully with the generated email action
10261026
* link. If an error occurs while generating the link, the future throws a
10271027
* {@link FirebaseAuthException}.
@@ -1079,9 +1079,9 @@ public ApiFuture<String> generateEmailVerificationLinkAsync(@NonNull String emai
10791079
* operation asynchronously.
10801080
*
10811081
* @param email The email of the user to be verified.
1082-
* @param settings The action code settings which defines whether
1082+
* @param settings The action code settings object which defines whether
10831083
* the link is to be handled by a mobile app and the additional state information to be
1084-
* passed in the deep link, etc.
1084+
* passed in the deep link.
10851085
* @return An {@code ApiFuture} which will complete successfully with the generated email action
10861086
* link. If an error occurs while generating the link, the future throws a
10871087
* {@link FirebaseAuthException}.
@@ -1098,9 +1098,9 @@ public ApiFuture<String> generateEmailVerificationLinkAsync(
10981098
* code settings provided.
10991099
*
11001100
* @param email The email of the user signing in.
1101-
* @param settings The action code settings which defines whether
1101+
* @param settings The action code settings object which defines whether
11021102
* the link is to be handled by a mobile app and the additional state information to be
1103-
* passed in the deep link, etc.
1103+
* passed in the deep link.
11041104
* @return An email verification link.
11051105
* @throws IllegalArgumentException If the email address is null or empty.
11061106
* @throws FirebaseAuthException If an error occurs while generating the link.
@@ -1115,9 +1115,9 @@ public String generateSignInWithEmailLink(
11151115
* operation asynchronously.
11161116
*
11171117
* @param email The email of the user signing in.
1118-
* @param settings The action code settings which defines whether
1118+
* @param settings The action code settings object which defines whether
11191119
* the link is to be handled by a mobile app and the additional state information to be
1120-
* passed in the deep link, etc.
1120+
* passed in the deep link.
11211121
* @return An {@code ApiFuture} which will complete successfully with the generated email action
11221122
* link. If an error occurs while generating the link, the future throws a
11231123
* {@link FirebaseAuthException}.

0 commit comments

Comments
 (0)