From 63714859292c7bac51b3e40d127439cf469a93ad Mon Sep 17 00:00:00 2001
From: Paul Schaub <vanitasvitae@fsfe.org>
Date: Mon, 17 Apr 2023 14:51:50 +0200
Subject: [PATCH] Add some clarifying comments to GenerateKeyImpl

---
 .../src/main/java/org/pgpainless/sop/GenerateKeyImpl.java     | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/pgpainless-sop/src/main/java/org/pgpainless/sop/GenerateKeyImpl.java b/pgpainless-sop/src/main/java/org/pgpainless/sop/GenerateKeyImpl.java
index d2baf29b..ba788dac 100644
--- a/pgpainless-sop/src/main/java/org/pgpainless/sop/GenerateKeyImpl.java
+++ b/pgpainless-sop/src/main/java/org/pgpainless/sop/GenerateKeyImpl.java
@@ -63,13 +63,16 @@ public class GenerateKeyImpl implements GenerateKey {
 
     @Override
     public GenerateKey profile(String profileName) {
+        // Sanitize the profile name to make sure we support the given profile
         for (Profile profile : SUPPORTED_PROFILES) {
             if (profile.getName().equals(profileName)) {
                 this.profile = profileName;
+                // return if we found the profile
                 return this;
             }
         }
 
+        // profile not found, throw
         throw new SOPGPException.UnsupportedProfile("generate-key", profileName);
     }
 
@@ -126,6 +129,7 @@ public class GenerateKeyImpl implements GenerateKey {
                     .simpleRsaKeyRing(primaryUserId, RsaLength._4096, passphrase);
         }
         else {
+            // Missing else-if branch for profile. Oops.
             throw new SOPGPException.UnsupportedProfile("generate-key", profile);
         }
         return key;