docs: add XML documentation for security utility factories (Batch 6)#674
Open
KonradSop wants to merge 1 commit intobcgit:masterfrom
Open
docs: add XML documentation for security utility factories (Batch 6)#674KonradSop wants to merge 1 commit intobcgit:masterfrom
KonradSop wants to merge 1 commit intobcgit:masterfrom
Conversation
Document the six public factory entry points under crypto/src/security: CipherUtilities, DigestUtilities, MacUtilities, SignerUtilities, GeneratorUtilities, and ParameterUtilities. Adds class-level summaries describing the JCA-style algorithm-name conventions and per-method <summary>, <param>, <returns>, and <exception> tags for the public API surface. 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 six user-facing factory entry points under
crypto/src/security. These classes are the primary discovery surface for callers who reach for an algorithm by name (JCA-style) rather than by direct type, and previously carried little or no API documentation.CipherUtilities— class summary describing theALGORITHM[/MODE[/PADDING]]convention, plus<summary>/<param>/<returns>/<exception>forGetAlgorithmNameand bothGetCipheroverloads.DigestUtilities— factory and one-shot helpers: allCalculateDigest,DoFinaloverloads,GetAlgorithmName,GetDigest(string),GetDigest(DerObjectIdentifier),GetObjectIdentifier. Removed a stray duplicate<param name="mechanism">block that emitted CS1571.MacUtilities— class summary noting required initialization, plusCalculateMac, bothDoFinaloverloads,GetAlgorithmName,GetMac(string),GetMac(DerObjectIdentifier).SignerUtilities— class summary covering theDIGESTwithCIPHERconvention, plusAlgorithms,GetDefaultX509Parameters(both),GetEncodingName,GetSigner(both),InitSigner(both, with full parameter docs).GeneratorUtilities—GetKeyGenerator(both),GetKeyPairGenerator(both).ParameterUtilities—GetCanonicalAlgorithmName, all fourCreateKeyParameteroverloads, bothGetCipherParameters, bothGenerateParameters, plus theParametersWithRandom/ParametersWithContextenvelope helpers (GetContext,GetRandom,IgnoreRandom,WithContext,WithRandom).Key Accomplishments
<exception>tags only added where the method body actually throws — no speculative annotations.// TODO[api],// TODO, and inline implementation notes left verbatim.<see cref="..."/>used for type/member references rather than backticks.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.