From ae88fdf4ab0ba32b819b1dd40d76fb76d815ca44 Mon Sep 17 00:00:00 2001
From: Paul Schaub <vanitasvitae@fsfe.org>
Date: Fri, 11 Nov 2022 13:49:28 +0100
Subject: [PATCH] Document ArmoredOutputStreamFactory.setVersionInfo(null)

---
 .../java/org/pgpainless/util/ArmoredOutputStreamFactory.java     | 1 +
 1 file changed, 1 insertion(+)

diff --git a/pgpainless-core/src/main/java/org/pgpainless/util/ArmoredOutputStreamFactory.java b/pgpainless-core/src/main/java/org/pgpainless/util/ArmoredOutputStreamFactory.java
index 67cc1c20..fb2cd4f5 100644
--- a/pgpainless-core/src/main/java/org/pgpainless/util/ArmoredOutputStreamFactory.java
+++ b/pgpainless-core/src/main/java/org/pgpainless/util/ArmoredOutputStreamFactory.java
@@ -55,6 +55,7 @@ public final class ArmoredOutputStreamFactory {
     /**
      * Overwrite the version header of ASCII armors with a custom value.
      * Newlines in the version info string result in multiple version header entries.
+     * If this is set to <pre>null</pre>, then the version header is omitted altogether.
      *
      * @param versionString version string
      */