docs: add XML documentation for core parameter classes and digests#666
Open
KonradSop wants to merge 1 commit intobcgit:masterfrom
Open
docs: add XML documentation for core parameter classes and digests#666KonradSop wants to merge 1 commit intobcgit:masterfrom
KonradSop wants to merge 1 commit intobcgit:masterfrom
Conversation
Added XML documentation for RSA, EC, DH, DSA, and ElGamal parameter classes. Converted Sha256Digest and Sha512Digest JavaDoc to C# XML tags. Updated KeyParameter documentation for better IntelliSense.
Comment on lines
+30
to
+32
| .contributions/ | ||
| *.log | ||
| build_*.txt |
Collaborator
There was a problem hiding this comment.
Were these .gitignore changes intended to be part of the PR? If so, what tools/files do they relate to?
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.
Pull Request Description: Bouncy Castle C# Documentation Improvements
Description
This pull request improves the developer experience and IntelliSense support by adding comprehensive C# XML documentation (
/// <summary>) to key cryptographic parameter classes and digests.Currently, many core classes either lack documentation or use legacy Java-style comments (
/** ... */) which are not natively supported by C# IntelliSense in some IDE environments.Scope of Changes
RsaKeyParameters,RsaPrivateCrtKeyParameters.ECKeyParameters,ECPrivateKeyParameters,ECPublicKeyParameters.Future Work
If this contribution style is acceptable, I am prepared to continue with further PRs covering:
Verified by building the full BouncyCastle.sln (Build succeeded).
Checklist before requesting a review
See also Contributing Guidelines.