From 1c3cc19ff7f56a4087805fbe79800d03c240b115 Mon Sep 17 00:00:00 2001
From: Paul Schaub <vanitasvitae@fsfe.org>
Date: Thu, 3 Aug 2023 15:20:24 +0200
Subject: [PATCH] Add documentation to OpenPgpInputStream

---
 .../pgpainless/decryption_verification/OpenPgpInputStream.java | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/pgpainless-core/src/main/java/org/pgpainless/decryption_verification/OpenPgpInputStream.java b/pgpainless-core/src/main/java/org/pgpainless/decryption_verification/OpenPgpInputStream.java
index 028fa666..ff020a7b 100644
--- a/pgpainless-core/src/main/java/org/pgpainless/decryption_verification/OpenPgpInputStream.java
+++ b/pgpainless-core/src/main/java/org/pgpainless/decryption_verification/OpenPgpInputStream.java
@@ -45,6 +45,9 @@ import org.pgpainless.algorithm.SignatureType;
 import org.pgpainless.algorithm.StreamEncoding;
 import org.pgpainless.algorithm.SymmetricKeyAlgorithm;
 
+/**
+ * InputStream used to determine the nature of potential OpenPGP data.
+ */
 public class OpenPgpInputStream extends BufferedInputStream {
 
     @SuppressWarnings("CharsetObjectCanBeUsed")