Skip to content

Commit ca26325

Browse files
authored
fix: Fixing a series of javadoc warnings (#466)
1 parent 04e7038 commit ca26325

File tree

4 files changed

+22
-22
lines changed

4 files changed

+22
-22
lines changed

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -801,7 +801,7 @@ protected UserImportResult execute() throws FirebaseAuthException {
801801
* not guaranteed to correspond to the nth entry in the input parameters list.
802802
*
803803
* <p>A maximum of 100 identifiers may be specified. If more than 100 identifiers are
804-
* supplied, this method throws an {@link IllegalArgumentException}.
804+
* supplied, this method throws an {@code IllegalArgumentException}.
805805
*
806806
* @param identifiers The identifiers used to indicate which user records should be returned. Must
807807
* have 100 or fewer entries.
@@ -823,7 +823,7 @@ public GetUsersResult getUsers(@NonNull Collection<UserIdentifier> identifiers)
823823
* not guaranteed to correspond to the nth entry in the input parameters list.
824824
*
825825
* <p>A maximum of 100 identifiers may be specified. If more than 100 identifiers are
826-
* supplied, this method throws an {@link IllegalArgumentException}.
826+
* supplied, this method throws an {@code IllegalArgumentException}.
827827
*
828828
* @param identifiers The identifiers used to indicate which user records should be returned.
829829
* Must have 100 or fewer entries.
@@ -877,7 +877,7 @@ private boolean isUserFound(UserIdentifier id, Collection<UserRecord> userRecord
877877
* DeleteUsersResult.getSuccessCount() value.
878878
*
879879
* <p>A maximum of 1000 identifiers may be supplied. If more than 1000 identifiers are
880-
* supplied, this method throws an {@link IllegalArgumentException}.
880+
* supplied, this method throws an {@code IllegalArgumentException}.
881881
*
882882
* <p>This API has a rate limit of 1 QPS. Exceeding the limit may result in a quota exceeded
883883
* error. If you want to delete more than 1000 users, we suggest adding a delay to ensure you
@@ -886,7 +886,7 @@ private boolean isUserFound(UserIdentifier id, Collection<UserRecord> userRecord
886886
* @param uids The uids of the users to be deleted. Must have <= 1000 entries.
887887
* @return The total number of successful/failed deletions, as well as the array of errors that
888888
* correspond to the failed deletions.
889-
* @throw IllegalArgumentException If any of the identifiers are invalid or if more than 1000
889+
* @throws IllegalArgumentException If any of the identifiers are invalid or if more than 1000
890890
* identifiers are specified.
891891
* @throws FirebaseAuthException If an error occurs while deleting users.
892892
*/
@@ -902,7 +902,7 @@ public DeleteUsersResult deleteUsers(List<String> uids) throws FirebaseAuthExcep
902902
* deletions, as well as the array of errors that correspond to the failed deletions. If an
903903
* error occurs while deleting the user account, the future throws a
904904
* {@link FirebaseAuthException}.
905-
* @throw IllegalArgumentException If any of the identifiers are invalid or if more than 1000
905+
* @throws IllegalArgumentException If any of the identifiers are invalid or if more than 1000
906906
* identifiers are specified.
907907
*/
908908
public ApiFuture<DeleteUsersResult> deleteUsersAsync(List<String> uids) {

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

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ public String getNextPageToken() {
8888
@Override
8989
public ListProviderConfigsPage<T> getNextPage() {
9090
if (hasNextPage()) {
91-
Factory<T> factory = new Factory<T>(source, maxResults, currentBatch.getPageToken());
91+
Factory<T> factory = new Factory<>(source, maxResults, currentBatch.getPageToken());
9292
try {
9393
return factory.create();
9494
} catch (FirebaseAuthException e) {
@@ -99,25 +99,25 @@ public ListProviderConfigsPage<T> getNextPage() {
9999
}
100100

101101
/**
102-
* Returns an {@link Iterable} that facilitates transparently iterating over all the provider
102+
* Returns an {@code Iterable} that facilitates transparently iterating over all the provider
103103
* configs in the current Firebase project, starting from this page.
104104
*
105-
* <p>The {@link Iterator} instances produced by the returned {@link Iterable} never buffers more
105+
* <p>The {@code Iterator} instances produced by the returned {@code Iterable} never buffers more
106106
* than one page of provider configs at a time. It is safe to abandon the iterators (i.e. break
107107
* the loops) at any time.
108108
*
109-
* @return a new {@link Iterable} instance.
109+
* @return a new {@code Iterable} instance.
110110
*/
111111
@NonNull
112112
@Override
113113
public Iterable<T> iterateAll() {
114-
return new ProviderConfigIterable<T>(this);
114+
return new ProviderConfigIterable<>(this);
115115
}
116116

117117
/**
118-
* Returns an {@link Iterable} over the provider configs in this page.
118+
* Returns an {@code Iterable} over the provider configs in this page.
119119
*
120-
* @return a {@link Iterable} instance.
120+
* @return a {@code Iterable} instance.
121121
*/
122122
@NonNull
123123
@Override
@@ -136,7 +136,7 @@ private static class ProviderConfigIterable<T extends ProviderConfig> implements
136136
@Override
137137
@NonNull
138138
public Iterator<T> iterator() {
139-
return new ProviderConfigIterator<T>(startingPage);
139+
return new ProviderConfigIterator<>(startingPage);
140140
}
141141

142142
/**
@@ -230,7 +230,7 @@ public ListSamlProviderConfigsResponse fetch(int maxResults, String pageToken)
230230
}
231231

232232
/**
233-
* A simple factory class for {@link ProviderConfigsPage} instances.
233+
* A simple factory class for {@link ListProviderConfigsPage} instances.
234234
*
235235
* <p>Performs argument validation before attempting to load any provider config data (which is
236236
* expensive, and hence may be performed asynchronously on a separate thread).
@@ -261,7 +261,7 @@ static class Factory<T extends ProviderConfig> {
261261

262262
ListProviderConfigsPage<T> create() throws FirebaseAuthException {
263263
ListProviderConfigsResponse<T> batch = source.fetch(maxResults, pageToken);
264-
return new ListProviderConfigsPage<T>(batch, source, maxResults);
264+
return new ListProviderConfigsPage<>(batch, source, maxResults);
265265
}
266266
}
267267
}

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ public static final class UpdateRequest extends AbstractUpdateRequest<UpdateRequ
132132
* provider.
133133
*
134134
* <p>The returned object should be passed to
135-
* {@link AbstractFirebaseAuth#updateOidcProviderConfig(CreateRequest)} to save the updated
135+
* {@link AbstractFirebaseAuth#updateOidcProviderConfig(UpdateRequest)} to save the updated
136136
* config.
137137
*
138138
* @param providerId A non-null, non-empty provider ID string.

src/main/java/com/google/firebase/auth/multitenancy/ListTenantsPage.java

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -96,14 +96,14 @@ public ListTenantsPage getNextPage() {
9696
}
9797

9898
/**
99-
* Returns an {@link Iterable} that facilitates transparently iterating over all the tenants in
99+
* Returns an {@code Iterable} that facilitates transparently iterating over all the tenants in
100100
* the current Firebase project, starting from this page.
101101
*
102-
* <p>The {@link Iterator} instances produced by the returned {@link Iterable} never buffers more
102+
* <p>The {@code Iterator} instances produced by the returned {@code Iterable} never buffers more
103103
* than one page of tenants at a time. It is safe to abandon the iterators (i.e. break the loops)
104104
* at any time.
105105
*
106-
* @return a new {@link Iterable} instance.
106+
* @return a new {@code Iterable} instance.
107107
*/
108108
@NonNull
109109
@Override
@@ -112,9 +112,9 @@ public Iterable<Tenant> iterateAll() {
112112
}
113113

114114
/**
115-
* Returns an {@link Iterable} over the tenants in this page.
115+
* Returns an {@code Iterable} over the tenants in this page.
116116
*
117-
* @return a {@link Iterable} instance.
117+
* @return a {@code Iterable} instance.
118118
*/
119119
@NonNull
120120
@Override
@@ -137,7 +137,7 @@ public Iterator<Tenant> iterator() {
137137
}
138138

139139
/**
140-
* An {@link Iterator} that cycles through tenants, one at a time.
140+
* An {@code Iterator} that cycles through tenants, one at a time.
141141
*
142142
* <p>It buffers the last retrieved batch of tenants in memory. The {@code maxResults} parameter
143143
* is an upper bound on the batch size.

0 commit comments

Comments
 (0)