docs: add XML documentation for CMS SignedData generator (Batch 12a-3)#686
Open
KonradSop wants to merge 1 commit into
Open
docs: add XML documentation for CMS SignedData generator (Batch 12a-3)#686KonradSop wants to merge 1 commit into
KonradSop wants to merge 1 commit into
Conversation
Document CmsSignedDataGenerator: class summary, constructors, all AddSigner overload families, AddSignerInfoGenerator, Generate overloads, GenerateCounterSigners and UseDefiniteLength. Converts legacy block comments to XML with accurate CmsException contracts on generation paths. Wrap a pre-existing commented line to the 120-character limit. No behavioural changes.
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
CmsSignedDataGenerator— the primary entry point for creating CMSSignedData (PKCS#7 signed-data) messages:
CmsSignedGenerator.SecureRandomoverload.AddSigneroverloads — all four families documented (certificate vs subject key id; defaultattributes vs
AttributeTablevsCmsAttributeTableGenerator; inferred vs explicit encryption OID).AddSignerInfoGenerator— documents theSignerInfoGeneratorintegration path.Generateoverloads — documents encapsulated vs detached content and explicit content type OID;<exception cref="CmsException"/>on paths that catch and rethrow signing/encoding failures.GenerateCounterSigners— documents counter-signature generation.UseDefiniteLength— documents DL encoding preference.Legacy
/**block comments converted to XML. One pre-existing commented line wrapped to ≤120 characters.Key Accomplishments
AddCertificates/AddCrlsfrom the base class.CmsExceptiondocumented only onGenerateandGenerateCounterSignerswhere the implementation wraps failures.Verification
dotnet build crypto/src/BouncyCastle.Crypto.csproj -c Release— 0 errors, no new warnings.Checklist before requesting a review
See also Contributing Guidelines.