docs: add XML documentation for CMS exceptions and PBE keys (Batch 16e) - #713
Open
KonradSop wants to merge 1 commit into
Open
docs: add XML documentation for CMS exceptions and PBE keys (Batch 16e)#713KonradSop wants to merge 1 commit into
KonradSop 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
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.
Description
Adds XML documentation to CMS exception types and password-based key classes used with enveloped-data
recipients:
CmsExceptionand derived types - class summaries forCmsAttributeTableGenerationException,CmsStreamException,CmsAlgorithmNotAllowedException,CmsTagLengthException, andCmsVerifierCertificateNotValidException.CmsPbeKey- base class summary, constructors, properties, andGetEncoded; links toCmsEnvelopedGenerator.AddPasswordRecipient.Pkcs5Scheme2Utf8PbeKey/Pkcs5Scheme2PbeKey- UTF-8 vs ASCII password encoding; publicconstructors documented with
<inheritdoc/>.Legacy
/**block comments converted to XML where present.Key Accomplishments
AddPasswordRecipient.<exception>only onCmsPbeKeyconstructors where PBKDF2 is validated.///lines are at most 120 characters.Verification
dotnet build crypto/src/BouncyCastle.Crypto.csproj -c Release- 0 errors, no new warnings.Checklist before requesting a review
See also Contributing Guidelines.