PGPainless/pgpainless
PGPainless/pgpainless
1
0
Fork 0
mirror of https://github.com/pgpainless/pgpainless.git synced 2024-11-22 20:32:05 +01:00
Code Issues Releases Wiki Activity

Add p-tags to EncryptionOptions javadoc

Browse source
This commit is contained in:
Paul Schaub 2023-05-03 14:38:38 +02:00
parent 15f6cc70b1
commit 304350fe5c
Signed by: vanitasvitae
GPG key ID: 62BEE9264BF17311
1 changed files with 4 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
pgpainless-core/src/main/java/org/pgpainless/encryption_signing/EncryptionOptions.java
View file

@ -33,7 +33,7 @@ import org.pgpainless.util.Passphrase;
/** /**
* Options for the encryption process. * Options for the encryption process.
* This class can be used to set encryption parameters, like encryption keys and passphrases, algorithms etc. * This class can be used to set encryption parameters, like encryption keys and passphrases, algorithms etc.
* * <p>
* A typical use might look like follows: * A typical use might look like follows:
* <pre> * <pre>
* {@code * {@code
@ -42,11 +42,11 @@ import org.pgpainless.util.Passphrase;
* opt.addPassphrase(Passphrase.fromPassword("AdditionalDecryptionPassphrase123")); * opt.addPassphrase(Passphrase.fromPassword("AdditionalDecryptionPassphrase123"));
* } * }
* </pre> * </pre>
* *<p>
* To use a custom symmetric encryption algorithm, use {@link #overrideEncryptionAlgorithm(SymmetricKeyAlgorithm)}. * To use a custom symmetric encryption algorithm, use {@link #overrideEncryptionAlgorithm(SymmetricKeyAlgorithm)}.
* This will cause PGPainless to use the provided algorithm for message encryption, instead of negotiating an algorithm * This will cause PGPainless to use the provided algorithm for message encryption, instead of negotiating an algorithm
* by inspecting the provided recipient keys. * by inspecting the provided recipient keys.
* * <p>
* By default, PGPainless will encrypt to all suitable, encryption capable subkeys on each recipient's certificate. * By default, PGPainless will encrypt to all suitable, encryption capable subkeys on each recipient's certificate.
* This behavior can be changed per recipient, e.g. by calling * This behavior can be changed per recipient, e.g. by calling
* <pre> * <pre>
@ -83,7 +83,7 @@ public class EncryptionOptions {
* Factory method to create an {@link EncryptionOptions} object which will encrypt for keys * Factory method to create an {@link EncryptionOptions} object which will encrypt for keys
* which carry either the {@link org.pgpainless.algorithm.KeyFlag#ENCRYPT_COMMS} or * which carry either the {@link org.pgpainless.algorithm.KeyFlag#ENCRYPT_COMMS} or
* {@link org.pgpainless.algorithm.KeyFlag#ENCRYPT_STORAGE} flag. * {@link org.pgpainless.algorithm.KeyFlag#ENCRYPT_STORAGE} flag.
* * <p>
* Use this if you are not sure. * Use this if you are not sure.
* *
* @return encryption options * @return encryption options