From 376e234baf463b7a9c28d010f4b5e78f9fa55a00 Mon Sep 17 00:00:00 2001
From: Paul Schaub <vanitasvitae@fsfe.org>
Date: Tue, 28 Dec 2021 01:23:47 +0100
Subject: [PATCH] Add documentation to SecretKeyRingEditor

---
 .../SecretKeyRingEditorInterface.java          | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/pgpainless-core/src/main/java/org/pgpainless/key/modification/secretkeyring/SecretKeyRingEditorInterface.java b/pgpainless-core/src/main/java/org/pgpainless/key/modification/secretkeyring/SecretKeyRingEditorInterface.java
index 65d92330..c7655134 100644
--- a/pgpainless-core/src/main/java/org/pgpainless/key/modification/secretkeyring/SecretKeyRingEditorInterface.java
+++ b/pgpainless-core/src/main/java/org/pgpainless/key/modification/secretkeyring/SecretKeyRingEditorInterface.java
@@ -69,10 +69,28 @@ public interface SecretKeyRingEditorInterface {
             @Nonnull SecretKeyRingProtector protector)
             throws PGPException;
 
+    /**
+     * Convenience method to revoke selected user-ids using soft revocation signatures.
+     * The revocation will use {@link RevocationAttributes.Reason#USER_ID_NO_LONGER_VALID}, so that the user-id
+     * can be re-certified at a later point.
+     *
+     * @param userIdSelector selector to select user-ids
+     * @param protector protector to unlock the primary key
+     * @return the builder
+     */
     SecretKeyRingEditorInterface removeUserId(SelectUserId userIdSelector,
                                               SecretKeyRingProtector protector)
         throws PGPException;
 
+    /**
+     * Convenience method to revoke a single user-id using a soft revocation signature.
+     * The revocation will use {@link RevocationAttributes.Reason#USER_ID_NO_LONGER_VALID}. so that the user-id
+     * can be re-certified at a later point.
+     *
+     * @param userId user-id to revoke
+     * @param protector protector to unlock the primary key
+     * @return the builder
+     */
     SecretKeyRingEditorInterface removeUserId(CharSequence userId,
                                               SecretKeyRingProtector protector)
         throws PGPException;