Skip to content

fix: Fixing a series of javadoc warnings #466

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 1 commit into from
Aug 4, 2020
Merged

fix: Fixing a series of javadoc warnings #466

merged 1 commit into from
Aug 4, 2020

Conversation

hiranya911
Copy link
Contributor

Fixing the following javadoc warnings:

[WARNING] Javadoc Warnings
[WARNING] ~/hkj/Projects/firebase-admin-java/public/src/main/java/com/google/firebase/auth/AbstractFirebaseAuth.java:798: warning 101: Unresolved link/see tag "IllegalArgumentException" in com.google.firebase.auth.AbstractFirebaseAuth
[WARNING] ~/hkj/Projects/firebase-admin-java/public/src/main/java/com/google/firebase/auth/AbstractFirebaseAuth.java:820: warning 101: Unresolved link/see tag "IllegalArgumentException" in com.google.firebase.auth.AbstractFirebaseAuth
[WARNING] ~/hkj/Projects/firebase-admin-java/public/src/main/java/com/google/firebase/auth/AbstractFirebaseAuth.java:873: warning 101: Unresolved link/see tag "IllegalArgumentException" in com.google.firebase.auth.AbstractFirebaseAuth
[WARNING] ~/hkj/Projects/firebase-admin-java/public/src/main/java/com/google/firebase/auth/AbstractFirebaseAuth.java:889: warning 103: Unknown tag: @throw
[WARNING] ~hkj/Projects/firebase-admin-java/public/src/main/java/com/google/firebase/auth/AbstractFirebaseAuth.java:905: warning 103: Unknown tag: @throw
[WARNING] ~/hkj/Projects/firebase-admin-java/public/src/main/java/com/google/firebase/auth/ListProviderConfigsPage.java:104: warning 101: Unresolved link/see tag "Iterable" in com.google.firebase.auth.ListProviderConfigsPage
[WARNING] ~/hkj/Projects/firebase-admin-java/public/src/main/java/com/google/firebase/auth/ListProviderConfigsPage.java:104: warning 101: Unresolved link/see tag "Iterator" in com.google.firebase.auth.ListProviderConfigsPage
[WARNING] ~/hkj/Projects/firebase-admin-java/public/src/main/java/com/google/firebase/auth/ListProviderConfigsPage.java:107: warning 101: Unresolved link/see tag "Iterable" in com.google.firebase.auth.ListProviderConfigsPage
[WARNING] ~/hkj/Projects/firebase-admin-java/public/src/main/java/com/google/firebase/auth/ListProviderConfigsPage.java:118: warning 101: Unresolved link/see tag "Iterable" in com.google.firebase.auth.ListProviderConfigsPage
[WARNING] ~/hkj/Projects/firebase-admin-java/public/src/main/java/com/google/firebase/auth/ListProviderConfigsPage.java:120: warning 101: Unresolved link/see tag "Iterable" in com.google.firebase.auth.ListProviderConfigsPage
[WARNING] ~/hkj/Projects/firebase-admin-java/public/src/main/java/com/google/firebase/auth/OidcProviderConfig.java:131: warning 101: Unresolved link/see tag "AbstractFirebaseAuth#updateOidcProviderConfig(CreateRequest)" in com.google.firebase.auth.OidcProviderConfig.UpdateRequest
[WARNING] ~/hkj/Projects/firebase-admin-java/public/src/main/java/com/google/firebase/auth/multitenancy/ListTenantsPage.java:101: warning 101: Unresolved link/see tag "Iterable" in com.google.firebase.auth.multitenancy.ListTenantsPage
[WARNING] ~/hkj/Projects/firebase-admin-java/public/src/main/java/com/google/firebase/auth/multitenancy/ListTenantsPage.java:101: warning 101: Unresolved link/see tag "Iterator" in com.google.firebase.auth.multitenancy.ListTenantsPage
[WARNING] ~/hkj/Projects/firebase-admin-java/public/src/main/java/com/google/firebase/auth/multitenancy/ListTenantsPage.java:104: warning 101: Unresolved link/see tag "Iterable" in com.google.firebase.auth.multitenancy.ListTenantsPage
[WARNING] ~/Projects/firebase-admin-java/public/src/main/java/com/google/firebase/auth/multitenancy/ListTenantsPage.java:115: warning 101: Unresolved link/see tag "Iterable" in com.google.firebase.auth.multitenancy.ListTenantsPage
[WARNING] ~/hkj/Projects/firebase-admin-java/public/src/main/java/com/google/firebase/auth/multitenancy/ListTenantsPage.java:117: warning 101: Unresolved link/see tag "Iterable" in com.google.firebase.auth.multitenancy.ListTenantsPage

Specifically we cannot {@link } to classes that are not part of our codebase.

Copy link
Member

@lahirumaramba lahirumaramba left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you! LGTM
Left few comments

@@ -132,7 +132,7 @@ CreateRequest getThis() {
* provider.
*
* <p>The returned object should be passed to
* {@link AbstractFirebaseAuth#updateOidcProviderConfig(CreateRequest)} to save the updated
* {@link AbstractFirebaseAuth#updateOidcProviderConfig(UpdateRequest)} to save the updated
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Was this a bug? :)

Copy link
Contributor Author

@hiranya911 hiranya911 Aug 4, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes it was. A documentation error.

@@ -261,7 +261,7 @@ public ListSamlProviderConfigsResponse fetch(int maxResults, String pageToken)

ListProviderConfigsPage<T> create() throws FirebaseAuthException {
ListProviderConfigsResponse<T> batch = source.fetch(maxResults, pageToken);
return new ListProviderConfigsPage<T>(batch, source, maxResults);
return new ListProviderConfigsPage<>(batch, source, maxResults);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we do a project wide search for similar missing generics? :)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should at some point. Hopefully we can get an IDE to do the work all in one go.

@hiranya911 hiranya911 merged commit ca26325 into v7 Aug 4, 2020
@hiranya911 hiranya911 deleted the hkj-javadoc-fix branch August 4, 2020 17:43
hiranya911 added a commit that referenced this pull request Aug 18, 2020
* Added core types for the error handling revamp (#350)

* Added core types for the error handling revamp

* Fixed copyright year

* Added ErrorHandlingHttpClient API (#353)

* Added core error handling abstractions

* Added unit tests for the new functionality

* Exposed getErrorCode as getErrorCodeNew

* Enabled error code assertions

* Error handling revamp for the FirebaseMessaging API (#357)

* Added core error handling abstractions

* Added unit tests for the new functionality

* Exposed getErrorCode as getErrorCodeNew

* Enabled error code assertions

* Error handling revamp for FCM APIs

* Cleaned up the FirebaseMessagingException

* Cleaned up the AbstractHttpErrorHandler class

* Updated tests

* Error handling revamp for FirebaseInstanceId API (#359)

* Delete instance ID API error handling revamp

* Added tests for IO and parse errors

* fix(auth): Migrated user management APIs to the new error handling scheme (#360)

* Error handling revamp in FirebaseUserManager

* Updated integration tests; Added documentation

* Assigning the correct ErrorCode for auth errors

* Moved AuthErrorHandler to a separate top-level class

* Error handling revamp for token verification APIs (#362)

* Error handling revamp for token verification APIs

* Updated javadocs

* Error handling revamp for the custom token creation API (#366)

* Error handlign revamp for the custom token creation API

* Using the correct authorized HTTP client for IAM requests

* Error handling revamp for the project management API (#367)

* Error handling revamp for the project management API

* Minor code and test cleanup

* Fixed some lint errors; Removed requestFactory reference from project mgt service impl

* Renamed getErrorCodeNew() to getErrorCode() (#379)

* Minor code and test cleanup

* Renamed getErrorCodeNew() to getErrorCode() in FirebaseException

* Fixing checkstyle error

* Fixing some deprecation warnings (#380)

* Handling IID error codes correctly (#381)

* Removed old deprecated APIs (#383)

* fix: Removed unused FirebaseAppStore abstraction (#427)

* fix: Removed unused FirebaseAppStore abstraction

* Using the keySet of App instances to populate the app names list

* chore: Removing redundant test dependency (#441)

* chore: Make user import hashing classes final (#425)

* chore: Merged with v7 branch with master (#456)

* fix(fcm): Replacing deprecated Batch API constructor (#460)

* fix: Handling http method override in ErrorHandlingHttpClient (#459)

* fix: Handling JSON serialization/response interception at ErrorHandlingHttpClient (#462)

* fix: Handling JSON serialization and response interception at ErrorHandlingHttpClient

* fix: Removing redundant method override header

* feat: Added new error codes for IdP management and multitenancy (#458)

* feat: Added new error codes for IdP management and multitenancy

* fix: Updated integration tests

* fix: Renamed helper method

* fix: Removing some calls to deprecated APIs (#464)

* chore: Support for specifying query parameters in HttpRequestInfo (#463)

* chore: Support for specifying query parameters in HttpRequestInfo

* fix: Removing redundant JsonObjectParser from HttpClient

* fix: Fixing a series of javadoc warnings (#466)

* fix: Made some APIs on AbstractFirebaseAuth.Builder package-protected for consistency

* Apply suggestions from code review

Co-authored-by: egilmorez <[email protected]>
Co-authored-by: Kevin Cheung <[email protected]>

* fix: Minor updates to API ref docs based on code review comments

* fix: Fixing API doc wording

Co-authored-by: Horatiu Lazu <[email protected]>
Co-authored-by: egilmorez <[email protected]>
Co-authored-by: Kevin Cheung <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants