From 7eb2f5fb4d84768b4424470794b5f9a9fd015d85 Mon Sep 17 00:00:00 2001
From: Paul Schaub <vanitasvitae@fsfe.org>
Date: Sat, 2 Apr 2022 17:16:37 +0200
Subject: [PATCH] Document how PGPainlessCLI works

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

diff --git a/pgpainless-cli/src/main/java/org/pgpainless/cli/PGPainlessCLI.java b/pgpainless-cli/src/main/java/org/pgpainless/cli/PGPainlessCLI.java
index b199ec72..35791a3e 100644
--- a/pgpainless-cli/src/main/java/org/pgpainless/cli/PGPainlessCLI.java
+++ b/pgpainless-cli/src/main/java/org/pgpainless/cli/PGPainlessCLI.java
@@ -7,6 +7,10 @@ package org.pgpainless.cli;
 import org.pgpainless.sop.SOPImpl;
 import sop.cli.picocli.SopCLI;
 
+/**
+ * This class merely binds PGPainless to {@link SopCLI} by injecting a {@link SOPImpl} instance.
+ * CLI command calls are then simply forwarded to {@link SopCLI#execute(String[])}.
+ */
 public class PGPainlessCLI {
 
     static {