docs: add XML documentation for ML-KEM and ML-DSA parameter gaps (Batch 9)#679
Open
KonradSop wants to merge 1 commit intobcgit:masterfrom
Open
docs: add XML documentation for ML-KEM and ML-DSA parameter gaps (Batch 9)#679KonradSop wants to merge 1 commit intobcgit:masterfrom
KonradSop wants to merge 1 commit intobcgit:masterfrom
Conversation
Closes the documentation gaps left by the initial ML-KEM/ML-DSA documentation pass. Adds class-level summaries citing FIPS 203 / FIPS 204 and per-method <summary>, <param>, <returns>, and <exception> tags for the public API surface of MLKemParameterSet, MLKemKeyParameters, MLKemKeyGenerationParameters, MLDsaParameterSet, MLDsaKeyParameters, MLDsaKeyGenerationParameters, and MLDsaPrivateKeyParameters (including the Format enum and seed/encoding helpers). 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.
Closes the documentation gaps left by PR #673 (Batch 5, ML-KEM and ML-DSA initial pass). PR #673 covered
MLKemParameters,MLKemPublicKeyParameters,MLKemPrivateKeyParameters,MLDsaParametersandMLDsaPublicKeyParameters; this PR documents the remaining seven public types so the FIPS 203 / FIPS 204 surface is consistent.MLKemParameterSet— class summary citing FIPS 203; per-constant summaries naming each parameter set (NIST Category 1/3/5, module rankk); doc onEncapsulationLength,SecretLength,Name,ToString.MLKemKeyParameters— abstract base; class summary plusParametersaccessor doc.MLKemKeyGenerationParameters— class summary covering theSecureRandom+ parameter-set pairing and thestrength = 0rationale; both constructors document theirArgumentNullException/ArgumentExceptioncontracts.MLDsaParameterSet— class summary citing FIPS 204; per-constant summaries (NIST Category 2/3/5, modes 2/3/5); doc onName,ToString.MLDsaKeyParameters— abstract base; class summary plusParametersaccessor doc.MLDsaKeyGenerationParameters— same shape as the ML-KEM counterpart; OID-lookup constructor exception text notes both pure and HashML-DSA OIDs are accepted.MLDsaPrivateKeyParameters— class summary explaining the(ρ, K, tr, s₁, s₂, t₀)expansion plus cachedt₁.Formatenum documented per value (SeedOnly,EncodingOnly,SeedAndEncoding).FromEncoding, bothFromSeedoverloads,GetEncoded,GetPublicKey,GetPublicKeyEncoded,GetSeed,PreferredFormat,WithPreferredFormatdocumented with their full exception contracts.Key Accomplishments
<exception>tags only added where the method body actually throws —ArgumentNullException/ArgumentExceptiononFromEncoding,FromSeedand OID-lookup paths;InvalidOperationExceptiononWithPreferredFormatwhen a seed is required but unavailable.feature/modern-curves-docs(Batch 7) andfeature/slh-dsa-docs(Batch 8) — each of the seven files in this PR is untouched by either branch.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.