Improve PGP encrypt/decrypt file JavaDoc #75
Closed
Conversation
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
… fixed length open.
|
Merged. Thanks. |
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.
Improvements to the JavaDoc for the PGP APIs involved in file encryption/decryption (i.e. as used by the PBEFileProcessor sample).
I've tried to write them to aid discovery/usage - i.e. starting at PGPObjectFactory and PGPEncryptedDataGenerator leading someone to the types/methods they can use in the magic untyped streams.
There's a chance the docs are over-trained on the file encryption/decryption case (I haven't used the keyring/public key encryption side of things), so feel free to tinker or ask me to improve.
Also a few minor code changes (removing redundant methods/code) and a bunch of TODOs I didn't feel qualified to hack.