Skip to content

docs: add XML documentation for CMS SignedData stream parser (Batch 15g) - #706

Open
KonradSop wants to merge 1 commit into
bcgit:masterfrom
KonradSop:feature/cms-signed-data-parser-docs
Open

docs: add XML documentation for CMS SignedData stream parser (Batch 15g)#706
KonradSop wants to merge 1 commit into
bcgit:masterfrom
KonradSop:feature/cms-signed-data-parser-docs

Conversation

@KonradSop

Copy link
Copy Markdown
Contributor

Description

Adds XML documentation to CmsSignedDataParser — the streaming read-side counterpart to
CmsSignedData (Batch 12a-3, #686) and the parser-side pair to CmsSignedDataStreamGenerator
(Batch 13a, #687):

  • Class summary — describes the streaming verify workflow, the one-signer-per-pass constraint,
    and the requirement to drain encapsulated content before calling GetSignerInfos.
  • <remarks> — stream lifecycle (parser does not close the input stream; dispose the parser or
    close manually), no internal buffering, and a C# example covering drain → certificates → verify.
  • Constructors — all four overloads (byte[] / stream, with optional detached CmsTypedStream);
    <exception> tags on the core (CmsTypedStream, Stream) constructor.
  • Public APIVersion, DigestOids, GetSignerInfos, certificate/CRL/revocation stores,
    SignedContentType, GetSignedContent, and static ReplaceSigners /
    ReplaceCertificatesAndCrls.
  • Cross-referencesCmsSignedData, CmsSignedDataStreamGenerator, SignerInformation,
    SignerInformationStore, CmsTypedStream.Drain.

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