docs: fix javadoc grammar in the crypto package - #7
Open
Avicennasis wants to merge 1 commit into
Open
Avicennasis wants to merge 1 commit into
Avicennasis wants to merge 1 commit into
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes 20 verified javadoc grammar errors across 4 files in
sdk/digitalb2bclient/.../crypto/. Javadoc comments only - no code, no identifiers, no@paramnames touched.This method to be used to ...->This method is to be used to ...(missing verb)@param payload is the payload which will be encrypt,->which will be encrypted,(2x);... which will be decrypt,->which will be decrypted,(3x)This method to be used to verify of a signature->This method is to be used to verify a signature(missing verb + strayof);@return string This return of the signature.->This returns the signature.... to calculate PSS Salt Length based on public keyNote on scope:
This method to be used toappears 6 times inEncryption.java; 4 of those were the ones I set out to fix, but fixing 4 of 6 identical openings in one file would have looked arbitrary, so all 6 were corrected. The@paramtag names themselves are untouched, so nothing can drift out of sync with the method signatures.Deliberately left alone: the terse
set connect timeout with time unit HttpClient/keep alive durationsphrasing inconfig/Config.javaandconfig/ConfigBuilder.java, which is used consistently throughout those files and is a wording preference rather than an error.No functional changes - documentation comments only.