docs: add XML documentation for modern-curve parameters (Batch 7)#677
Open
KonradSop wants to merge 1 commit intobcgit:masterfrom
Open
docs: add XML documentation for modern-curve parameters (Batch 7)#677KonradSop wants to merge 1 commit intobcgit:masterfrom
KonradSop wants to merge 1 commit intobcgit:masterfrom
Conversation
Document the public/private/key-generation parameter classes for the RFC 8032 EdDSA and RFC 7748 X-DH curves: Ed25519, Ed448, X25519, X448. Adds class-level summaries citing the relevant RFC and per-method <summary>, <param>, <returns>, and <exception> tags for the public API (constructors, encoders, key derivation, sign/verify, agreement). 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.
Description
Adds XML documentation to the public/private/key-generation parameter classes for the RFC 8032 EdDSA curves (Ed25519, Ed448) and RFC 7748 X-DH curves (X25519, X448). These are user-facing entry points for modern signing and key-agreement workflows that previously carried no API documentation.
Encode/GetEncodedsummaries;Verifydocumenting the pure / context / prehash variant selector and the conditions each places onctxandmsgLen.Encode/GetEncoded;GeneratePublicKey;Signmirroring theVerifydocumentation.Encode/GetEncoded.GeneratePublicKey;GenerateSecretdocumenting theInvalidOperationExceptionraised on degenerate (all-zero) secrets.Key Accomplishments
<exception>tags only added where the method body actually throws — the EdDSAVerify/Signalgorithm-selector exceptions, X-DH agreement failure, length-validation guards, and stream-EOF guards.<see cref=...>.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.