From: Svjatoslav Agejenko <svjatoslav@svjatoslav.eu>
Date: Thu, 12 Jun 2025 21:02:38 +0000 (+0300)
Subject: Better JavaDoc
X-Git-Url: http://www2.svjatoslav.eu/gitweb/?a=commitdiff_plain;h=32d2582a651d5290dd1740f74b834b8dd002d33c;p=alyverkko-cli.git

Better JavaDoc
---

diff --git a/src/main/java/eu/svjatoslav/alyverkko_cli/commands/mail_correspondant/package-info.java b/src/main/java/eu/svjatoslav/alyverkko_cli/commands/mail_correspondant/package-info.java
new file mode 100644
index 0000000..64ce203
--- /dev/null
+++ b/src/main/java/eu/svjatoslav/alyverkko_cli/commands/mail_correspondant/package-info.java
@@ -0,0 +1,9 @@
+/**
+ * This package contains mail processing commands for the Älyverkko CLI application.
+ * <p>
+ * The MailCorrespondentCommand monitors a mail directory for tasks and processes them
+ * using AI models. MailQuery encapsulates the data needed for each mail-based query.
+ * </p>
+ */
+
+package eu.svjatoslav.alyverkko_cli.commands.mail_correspondant;
\ No newline at end of file
diff --git a/src/main/java/eu/svjatoslav/alyverkko_cli/commands/package-info.java b/src/main/java/eu/svjatoslav/alyverkko_cli/commands/package-info.java
new file mode 100644
index 0000000..0d525af
--- /dev/null
+++ b/src/main/java/eu/svjatoslav/alyverkko_cli/commands/package-info.java
@@ -0,0 +1,9 @@
+/**
+ * This package contains all command implementations for the Älyverkko CLI application.
+ * <p>
+ * Each command class implements the Command interface and provides functionality for
+ * specific user actions like model management, file joining, and mail processing.
+ * </p>
+ */
+
+package eu.svjatoslav.alyverkko_cli.commands;
\ No newline at end of file
diff --git a/src/main/java/eu/svjatoslav/alyverkko_cli/configuration/package-info.java b/src/main/java/eu/svjatoslav/alyverkko_cli/configuration/package-info.java
new file mode 100644
index 0000000..c95e44c
--- /dev/null
+++ b/src/main/java/eu/svjatoslav/alyverkko_cli/configuration/package-info.java
@@ -0,0 +1,10 @@
+/**
+ * This package contains configuration-related classes for the Älyverkko CLI application.
+ * <p>
+ * The Configuration class holds global settings, while ConfigurationModel represents
+ * individual model configurations. ConfigurationHelper provides utility methods for
+ * loading and managing configuration files.
+ * </p>
+ */
+
+package eu.svjatoslav.alyverkko_cli.configuration;
\ No newline at end of file
diff --git a/src/main/java/eu/svjatoslav/alyverkko_cli/model/package-info.java b/src/main/java/eu/svjatoslav/alyverkko_cli/model/package-info.java
new file mode 100644
index 0000000..9fb1aca
--- /dev/null
+++ b/src/main/java/eu/svjatoslav/alyverkko_cli/model/package-info.java
@@ -0,0 +1,9 @@
+/**
+ * This package contains classes for managing AI models in the Älyverkko CLI application.
+ * <p>
+ * The Model class represents an AI model with metadata like path and context size.
+ * The ModelLibrary class manages a collection of models, providing lookup and validation.
+ * </p>
+ */
+
+package eu.svjatoslav.alyverkko_cli.model;
\ No newline at end of file
diff --git a/src/main/java/eu/svjatoslav/alyverkko_cli/package-info.java b/src/main/java/eu/svjatoslav/alyverkko_cli/package-info.java
new file mode 100644
index 0000000..619e817
--- /dev/null
+++ b/src/main/java/eu/svjatoslav/alyverkko_cli/package-info.java
@@ -0,0 +1,7 @@
+/**
+ * This package contains core components of the Älyverkko CLI application.
+ * <p>
+ * It includes the Main entry point, Command interface, and utility classes like Utils.
+ */
+
+package eu.svjatoslav.alyverkko_cli;
\ No newline at end of file