fix: JavaDoc improvements

app/src/main/java/zeroecho/package-info.java

@@ -0,0 +1,79 @@
+/**
+ * Copyright (C) 2025, Leo Galambos
+ * All rights reserved.
+ * 
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ * 
+ * 1. Redistributions of source code must retain the above copyright notice,
+ *    this list of conditions and the following disclaimer.
+ * 
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ *    this list of conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ *
+ * 3. All advertising materials mentioning features or use of this software must
+ *    display the following acknowledgement:
+ *    This product includes software developed by the Egothor project.
+ *
+ * 4. Neither the name of the copyright holder nor the names of its contributors
+ *    may be used to endorse or promote products derived from this software
+ *    without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
+/**
+ * <h2>ZeroEcho Command-Line Tools</h2>
+ *
+ * <p>
+ * This package contains a suite of command-line utilities that act as a
+ * user-facing interface to the underlying <code>zeroecho</code> library module.
+ * These tools are designed to support secure file encryption, key management,
+ * certificate authority operations, and advanced cryptographic workflows from
+ * the terminal.
+ * </p>
+ *
+ * <h3>Capabilities</h3>
+ *
+ * <p>
+ * The command-line utilities included in this package demonstrate the
+ * versatility of the ZeroEcho library in real-world scenarios, including:
+ * </p>
+ *
+ * <ul>
+ * <li><b>Asymmetric Key and Certificate Management:</b> Manage key pairs, X.509
+ * certificates, and Certificate Authority (CA) operations via
+ * <code>AsymetricKeysManagement</code> and <code>ZeroEcho</code>.</li>
+ *
+ * <li><b>Authenticated Encryption:</b> Use AES-GCM and related modes with
+ * password- or key-based mechanisms through <code>PasswordBasedAes</code>,
+ * <code>KEMAes</code>, and <code>MultiRecipientAes</code>.</li>
+ *
+ * <li><b>Key Encapsulation:</b> Perform AES encryption using encapsulated keys
+ * with hybrid cryptography patterns via <code>KEMAes</code>.</li>
+ *
+ * <li><b>Multi-Recipient Encryption:</b> Securely encrypt files for multiple
+ * recipients using independent public keys with
+ * <code>MultiRecipientAes</code>.</li>
+ *
+ * <li><b>KeyStore Interaction:</b> Load, inspect, and manage local keystore
+ * files with <code>KeyStoreManagement</code>.</li>
+ * </ul>
+ *
+ * <p>
+ * These tools are intended for developers, security analysts, and system
+ * administrators who need to integrate cryptographically secure operations into
+ * shell scripts, pipelines, or operational workflows without writing Java code.
+ * </p>
+ */
+package zeroecho;