From 980daeca31f5f1554f86f34eeb67164a7d73fc2b Mon Sep 17 00:00:00 2001
From: Paul Schaub <vanitasvitae@fsfe.org>
Date: Wed, 4 Jan 2023 18:55:57 +0100
Subject: [PATCH] Add missing javadoc to CustomPublicKeyDataDecryptorFactory

---
 .../CustomPublicKeyDataDecryptorFactory.java        | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/pgpainless-core/src/main/java/org/pgpainless/decryption_verification/CustomPublicKeyDataDecryptorFactory.java b/pgpainless-core/src/main/java/org/pgpainless/decryption_verification/CustomPublicKeyDataDecryptorFactory.java
index 37dc10a9..91902cc7 100644
--- a/pgpainless-core/src/main/java/org/pgpainless/decryption_verification/CustomPublicKeyDataDecryptorFactory.java
+++ b/pgpainless-core/src/main/java/org/pgpainless/decryption_verification/CustomPublicKeyDataDecryptorFactory.java
@@ -7,8 +7,21 @@ package org.pgpainless.decryption_verification;
 import org.bouncycastle.openpgp.operator.PublicKeyDataDecryptorFactory;
 import org.pgpainless.key.SubkeyIdentifier;
 
+/**
+ * Custom {@link PublicKeyDataDecryptorFactory} which can enable customized implementations of message decryption
+ * using public keys.
+ * This class can for example be used to implement message encryption using hardware tokens like smartcards or
+ * TPMs.
+ * @see ConsumerOptions#addCustomDecryptorFactory(CustomPublicKeyDataDecryptorFactory)
+ */
 public interface CustomPublicKeyDataDecryptorFactory extends PublicKeyDataDecryptorFactory {
 
+    /**
+     * Return the {@link SubkeyIdentifier} for which this particular {@link CustomPublicKeyDataDecryptorFactory}
+     * is intended.
+     *
+     * @return subkey identifier
+     */
     SubkeyIdentifier getSubkeyIdentifier();
 
 }