Skip to content

docs: add XML documentation for CMS SignerInfoGenerator (Batch 16b) - #710

Open
KonradSop wants to merge 2 commits into
bcgit:masterfrom
KonradSop:feature/cms-signer-info-generator-docs
Open

docs: add XML documentation for CMS SignerInfoGenerator (Batch 16b)#710
KonradSop wants to merge 2 commits into
bcgit:masterfrom
KonradSop:feature/cms-signer-info-generator-docs

Conversation

@KonradSop

Copy link
Copy Markdown
Contributor

Description

Adds XML documentation to SignerInfoGenerator and SignerInfoGeneratorBuilder - the
pre-configured signer types used with CmsSignedDataGenerator.AddSignerInfoGenerator (Batch 12a-3,
#686):

  • SignerInfoGenerator - class summary and write-side workflow; properties (Certificate,
    GeneratedVersion, SignatureFactory, attribute generators, SignerID); NewBuilder.
  • SignerInfoGeneratorBuilder - <remarks> for direct-signature vs default signed attributes;
    SetDirectSignature, WithSignedAttributeGenerator, WithUnsignedAttributeGenerator, and both
    Build overloads (X.509 certificate vs subject key identifier).

Legacy /** block comments converted to XML.

Key Accomplishments

Verification

  • Build Status: dotnet build crypto/src/BouncyCastle.Crypto.csproj -c Release - 0 errors, no new warnings.
  • Line length: all new or modified /// lines are at most 120 characters.
  • Scope: Documentation-only; no behavioural or signature changes.

Checklist before requesting a review

  • I have performed a self-review of my code
  • I have kept the patch limited to only change the parts related to the patch
  • This change requires a documentation update

See also Contributing Guidelines.

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.

1 participant