Document how PGPainlessCLI works

2022-04-02 17:16:37 +02:00 · 2022-04-02 17:16:37 +02:00 · 7eb2f5fb4d
parent 6869c66937
commit 7eb2f5fb4d
1 changed files with 4 additions and 0 deletions
--- 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 {