From 2e6664551ecc5d91cf8ca1fb72235fdaf998f260 Mon Sep 17 00:00:00 2001 From: Leo Galambos Date: Mon, 4 Aug 2025 23:43:23 +0200 Subject: [PATCH] fix: JavaDoc improvements --- app/src/main/java/zeroecho/package-info.java | 79 ++++++++++++++++++++ lib/build.gradle | 1 + lib/src/main/javadoc/overview.html | 44 +++++++++++ 3 files changed, 124 insertions(+) create mode 100644 app/src/main/java/zeroecho/package-info.java create mode 100644 lib/src/main/javadoc/overview.html diff --git a/app/src/main/java/zeroecho/package-info.java b/app/src/main/java/zeroecho/package-info.java new file mode 100644 index 0000000..33bfe0c --- /dev/null +++ b/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. + */ +/** + *

ZeroEcho Command-Line Tools

+ * + *

+ * This package contains a suite of command-line utilities that act as a + * user-facing interface to the underlying zeroecho library module. + * These tools are designed to support secure file encryption, key management, + * certificate authority operations, and advanced cryptographic workflows from + * the terminal. + *

+ * + *

Capabilities

+ * + *

+ * The command-line utilities included in this package demonstrate the + * versatility of the ZeroEcho library in real-world scenarios, including: + *

+ * + * + * + *

+ * 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. + *

+ */ +package zeroecho; \ No newline at end of file diff --git a/lib/build.gradle b/lib/build.gradle index 077853e..09040fc 100644 --- a/lib/build.gradle +++ b/lib/build.gradle @@ -13,4 +13,5 @@ dependencies { javadoc { options.links("https://www.egothor.org/javadoc/conflux") + options.overview = file("src/main/javadoc/overview.html") } \ No newline at end of file diff --git a/lib/src/main/javadoc/overview.html b/lib/src/main/javadoc/overview.html new file mode 100644 index 0000000..6ea6d6f --- /dev/null +++ b/lib/src/main/javadoc/overview.html @@ -0,0 +1,44 @@ + + + + + ZeroEcho API Library + + +

+ The ZeroEcho library provides a cohesive and extensible toolkit for secure data processing, cryptographic transformation, + and covert communication. Its architecture is centered around composability: data flows through builder-defined pipelines, + enabling dynamic combinations of encoding, encryption, formatting, and output strategies. +

+ +

+ ZeroEcho is particularly suited for applications that require secure transmission or obfuscation of binary data in + constrained or adversarial environments - including command-line payload delivery, steganographic embedding, + and post-quantum cryptographic operations. +

+ +

Design Principles

+ + +

Key Capabilities

+

+ The library includes: +

+ + +

+ ZeroEcho aims to bridge high-assurance cryptographic practices with practical concerns around portability, + concealment, and controlled delivery - whether in a CLI toolchain, embedded device, or secure messaging layer. +

+ +