docs: add XML documentation for X.509 certificate and CRL generators (Batch 12a-1)#684
Closed
KonradSop wants to merge 1 commit into
Closed
docs: add XML documentation for X.509 certificate and CRL generators (Batch 12a-1)#684KonradSop wants to merge 1 commit into
KonradSop wants to merge 1 commit into
Conversation
Document and modernise the public API of X509V1CertificateGenerator, X509V2CrlGenerator and X509V3CertificateGenerator (RFC 5280). Converts legacy block comments on the CRL generator to XML, fills gaps on all three generators (constructors, SetValidity, extension helpers, exception contracts) and wraps overlong serial-number remarks to stay within the 120-character line limit. No behavioural changes.
This was referenced Jun 8, 2026
Collaborator
|
Merged, thanks. |
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
2 participants
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 and modernises XML documentation for the three RFC 5280 certificate/CRL generators under
crypto/src/x509:X509V1CertificateGenerator— class summary citing RFC 5280; documentsSetValidityand<exception>tags onSetSerialNumberandSetPublicKey; wraps the serial-number<remarks>tothe 120-character line limit.
X509V2CrlGenerator— converts legacy block comments to XML; adds class summary; documentsdefault and template constructors, issuer/dates, all
AddCrlEntryoverloads,AddCrl,AddExtension, and bothGenerateoverloads (including alternate-signature CRLs); fixes theincorrect
<returns>cref on the alternate-signature overload (X509Crl, notX509Certificate).X509V3CertificateGenerator— expands class summary; documents missing constructors,SetValidity, undocumentedAddExtension/AddExtensionsoverloads, andCopyAndAddExtensionwith its
CertificateParsingException; adds<exception>onSetSerialNumber.Key Accomplishments
aligned with the PQC/modern-curve documentation batches.
<exception>only where the method body throws.<see cref>references, no blank lines inside<summary>, lines ≤120.and CMS to follow).
Verification
dotnet build crypto/src/BouncyCastle.Crypto.csproj -c Release— succeeded onnet6.0,netstandard2.0,net461with no new warnings.Checklist before requesting a review
See also Contributing Guidelines.