PGPainless/pgpainless
PGPainless/pgpainless
1
0
Fork 0
mirror of https://github.com/pgpainless/pgpainless.git synced 2024-11-29 15:52:08 +01:00
Code Issues Releases Wiki Activity

Some clarifications in javadoc

Browse source
This commit is contained in:
Paul Schaub 2022-02-24 01:08:23 +01:00
parent 367a07411d
commit fc33e56ad8
Signed by: vanitasvitae
GPG key ID: 62BEE9264BF17311
2 changed files with 7 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
pgpainless-core/src/main/java/org/pgpainless/encryption_signing/ProducerOptions.java
View file

@ -109,10 +109,13 @@ public final class ProducerOptions {
} }
/** /**
* set the comment for header in ascii armored output. * Set the comment header in ASCII armored output.
* The default value is null, which means no comment header is added. * The default value is null, which means no comment header is added.
* Multiline comments are possible using '\\n'. * Multiline comments are possible using '\\n'.
* *
* Note: If a default header comment is set using {@link org.pgpainless.util.ArmoredOutputStreamFactory#setComment(String)},
* then both comments will be written to the produced ASCII armor.
*
* @param comment comment header text * @param comment comment header text
* @return builder * @return builder
*/ */

3
pgpainless-core/src/main/java/org/pgpainless/util/ArmoredOutputStreamFactory.java
View file

@ -61,6 +61,9 @@ public final class ArmoredOutputStreamFactory {
* Set a comment header value in the ASCII armor header. * Set a comment header value in the ASCII armor header.
* If the comment contains newlines, it will be split into multiple header entries. * If the comment contains newlines, it will be split into multiple header entries.
* *
* @see org.pgpainless.encryption_signing.ProducerOptions#setComment(String) for how to set comments for
* individual messages.
*
* @param commentString comment * @param commentString comment
*/ */
public static void setComment(String commentString) { public static void setComment(String commentString) {