From 6ba7e91f2a57eecdd510ebcae3b178a1116ca432 Mon Sep 17 00:00:00 2001
From: Paul Schaub <vanitasvitae@fsfe.org>
Date: Wed, 16 Nov 2022 18:00:44 +0100
Subject: [PATCH] Add documentation and removal-TODO to old OpenPgpMetadata
 class

---
 .../pgpainless/decryption_verification/OpenPgpMetadata.java | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/pgpainless-core/src/main/java/org/pgpainless/decryption_verification/OpenPgpMetadata.java b/pgpainless-core/src/main/java/org/pgpainless/decryption_verification/OpenPgpMetadata.java
index 130ea554..e26fb804 100644
--- a/pgpainless-core/src/main/java/org/pgpainless/decryption_verification/OpenPgpMetadata.java
+++ b/pgpainless-core/src/main/java/org/pgpainless/decryption_verification/OpenPgpMetadata.java
@@ -27,6 +27,12 @@ import org.pgpainless.key.OpenPgpFingerprint;
 import org.pgpainless.key.SubkeyIdentifier;
 import org.pgpainless.util.SessionKey;
 
+/**
+ * Legacy class containing metadata about an OpenPGP message.
+ * It is advised to use {@link MessageMetadata} instead.
+ *
+ * TODO: Remove in 1.5.X
+ */
 public class OpenPgpMetadata {
 
     private final Set<Long> recipientKeyIds;