docs: add XML documentation for ML-KEM and ML-DSA parameters (Batch 5)#673
Closed
KonradSop wants to merge 1 commit intobcgit:masterfrom
Closed
docs: add XML documentation for ML-KEM and ML-DSA parameters (Batch 5)#673KonradSop wants to merge 1 commit intobcgit:masterfrom
KonradSop wants to merge 1 commit intobcgit:masterfrom
Conversation
Adds XML documentation for the public API surface of the ML-KEM (FIPS 203) and ML-DSA (FIPS 204) parameter classes. Covers the standard parameter set constants, key creation factories, encoding accessors, and the seed/encoding format enum for ML-KEM private keys. - MLKemParameters: algorithm parameter sets (ml_kem_512/768/1024) - MLKemPublicKeyParameters: FromEncoding, GetEncoded - MLKemPrivateKeyParameters: Format enum, FromEncoding, FromSeed (both overloads), GetEncoded, GetPublicKey, GetPublicKeyEncoded, GetSeed, PreferredFormat, WithPreferredFormat - MLDsaParameters: pure and HashML-DSA with SHA-512 variants - MLDsaPublicKeyParameters: FromEncoding, GetEncoded
Collaborator
|
Thanks for the PR. Rebased and merged. |
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.
Describe your changes
Adds XML documentation for the public API surface of the ML-KEM (FIPS 203) and ML-DSA (FIPS 204) parameter classes. This is Batch 5 of the ongoing documentation effort, following the pattern established in merged PRs #666, #669 and the in-review PRs #670, #671.
Files covered:
MLKemParameters— parameter set constants (ml_kem_512/768/1024) +Name,ParameterSet,ToString.MLKemPublicKeyParameters— class summary,FromEncoding,GetEncoded.MLKemPrivateKeyParameters— class summary,Formatenum (incl. per-value descriptions),FromEncoding, bothFromSeedoverloads,GetEncoded,GetPublicKey,GetPublicKeyEncoded,GetSeed,PreferredFormat,WithPreferredFormat.MLDsaParameters— pure and HashML-DSA-with-SHA512 variants,IsPreHash,Name,ParameterSet,ToString.MLDsaPublicKeyParameters— class summary,FromEncoding,GetEncoded.No behavioural changes. References to FIPS 203 / FIPS 204 are included where it clarifies semantics.
How has this been tested?
dotnet build crypto/src/BouncyCastle.Crypto.csproj -c Releasesucceeds with 0 errors across all target frameworks (net6.0,netstandard2.0,net461). No new tests — this is a documentation-only change.Checklist before requesting a review