X Tutup
Skip to content

[SDK-3159] JavaDoc updated#577

Merged
poovamraj merged 3 commits intov4-devfrom
update-java-docs
Apr 21, 2022
Merged

[SDK-3159] JavaDoc updated#577
poovamraj merged 3 commits intov4-devfrom
update-java-docs

Conversation

@poovamraj
Copy link
Copy Markdown
Contributor

Changes

We have updated the Java doc with relevant information and made a few required changes.

This includes

  • removing deprecation notices
  • using more Java doc features
  • other grammatical improvements

@poovamraj poovamraj requested a review from a team as a code owner April 20, 2022 13:38
@poovamraj poovamraj added this to the v4-Beta milestone Apr 20, 2022
@poovamraj poovamraj added documentation This adds, fixes or improves documentation review:medium Medium review CH: Added labels Apr 20, 2022
@poovamraj
Copy link
Copy Markdown
Contributor Author

Project coverage has decreased by 0.01% since we removed withAnyOfAudienceDeafultImplShouldThrow to test default method which has been removed

Copy link
Copy Markdown
Contributor

@jimmyjames jimmyjames left a comment

Choose a reason for hiding this comment

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

Looks great - I left a comment regarding your TODO. Once we address that, this is good to go 👍

* <p>
* This class is thread-safe.
*
* TODO Poovam - Should we claim thread safety since KeyProvider implementation can cause signing differ
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Do you mean that an implementation of KeyProvider may not be thread-safe, rendering this class not thread-safe? If so, we can claim thread safety of this class, and also document that implementations of KeyProvider must be thread-safe.


/**
* The "jti" (JWT ID) claim provides a unique identifier for the JWT.
* Refer RFC 7529 <a href="https://datatracker.ietf.org/doc/html/rfc7519#section-4.1.7">Section 4.1.7</a>
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

👍 these are nice

default Verification withAnyOfAudience(String... audience) {
throw new UnsupportedOperationException("withAnyOfAudience");
}
Verification withAnyOfAudience(String... audience);
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

👍 thanks for removing the default implementation

@poovamraj poovamraj changed the title JavaDoc updated [SDK-3159] JavaDoc updated Apr 21, 2022
@poovamraj poovamraj requested a review from jimmyjames April 21, 2022 13:19
@poovamraj poovamraj merged commit 6c4ea9e into v4-dev Apr 21, 2022
@poovamraj poovamraj modified the milestones: v4-Beta, 4.0.0-beta.0 May 6, 2022
@jimmyjames jimmyjames deleted the update-java-docs branch October 15, 2022 02:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CH: Added documentation This adds, fixes or improves documentation review:medium Medium review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

X Tutup