X-Git-Url: http://www2.svjatoslav.eu/gitweb/?a=blobdiff_plain;f=doc%2Findex.html;h=fc778b54184b215cd8120dcc38d555460942858f;hb=HEAD;hp=4648538b3c5da62ec529c6b653e4ae79d791a2cb;hpb=324ea20c0c65f671c0d35e94ed90142912a56b4c;p=cli-helper.git

diff --git a/doc/index.html b/doc/index.html
index 4648538..fc778b5 100644
--- a/doc/index.html
+++ b/doc/index.html
@@ -3,7 +3,7 @@
 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
 <head>
-<!-- 2023-10-12 Thu 22:18 -->
+<!-- 2024-04-25 Thu 17:30 -->
 <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
 <meta name="viewport" content="width=device-width, initial-scale=1" />
 <title>CLI Helper - library to help implementing commandline interfaces</title>
@@ -202,23 +202,25 @@
 <h2>Table of Contents</h2>
 <div id="text-table-of-contents" role="doc-toc">
 <ul>
-<li><a href="#orgf8634f9">1. General</a>
+<li><a href="#org9212145">1. General</a>
 <ul>
-<li><a href="#orgd17f1cf">1.1. Source code</a></li>
+<li><a href="#orgef4524a">1.1. Source code</a></li>
 </ul>
 </li>
-<li><a href="#org873ac39">2. Library contents</a>
+<li><a href="#org5a03d93">2. Overview</a>
 <ul>
-<li><a href="#org7e47dc1">2.1. Ask for user input</a></li>
+<li><a href="#orgbe808ef">2.1. Ask for user input</a></li>
 </ul>
 </li>
-<li><a href="#orge7ef3ef">3. Getting the library</a></li>
+<li><a href="#org20035ac">3. Alternatives and further reading</a></li>
+<li><a href="#org2e7a568">4. Getting the library</a></li>
+<li><a href="#orgcc45c0c">5. TODO:</a></li>
 </ul>
 </div>
 </div>
 
-<div id="outline-container-orgf8634f9" class="outline-2">
-<h2 id="orgf8634f9"><span class="section-number-2">1.</span> General</h2>
+<div id="outline-container-org9212145" class="outline-2">
+<h2 id="org9212145"><span class="section-number-2">1.</span> General</h2>
 <div class="outline-text-2" id="text-1">
 <ul class="org-ul">
 <li>This program is free software: released under Creative Commons Zero
@@ -235,8 +237,8 @@
 </ul>
 </div>
 
-<div id="outline-container-orgd17f1cf" class="outline-3">
-<h3 id="orgd17f1cf"><span class="section-number-3">1.1.</span> Source code</h3>
+<div id="outline-container-orgef4524a" class="outline-3">
+<h3 id="orgef4524a"><span class="section-number-3">1.1.</span> Source code</h3>
 <div class="outline-text-3" id="text-1-1">
 <ul class="org-ul">
 <li><a href="https://www2.svjatoslav.eu/gitweb/?p=cli-helper.git;a=snapshot;h=HEAD;sf=tgz">Download latest snapshot in TAR GZ format</a></li>
@@ -247,7 +249,7 @@
 Clone Git repository using command:
 </p>
 <pre class="example">
-git clone https://www2.svjatoslav.eu/git/cli-helper.git
+git clone https://www3.svjatoslav.eu/git/cli-helper.git
 </pre></li>
 
 <li>See <a href="https://www3.svjatoslav.eu/projects/cli-helper/apidocs/">JavaDoc</a></li>
@@ -256,28 +258,31 @@ git clone https://www2.svjatoslav.eu/git/cli-helper.git
 </div>
 </div>
 
-<div id="outline-container-org873ac39" class="outline-2">
-<h2 id="org873ac39"><span class="section-number-2">2.</span> Library contents</h2>
+<div id="outline-container-org5a03d93" class="outline-2">
+<h2 id="org5a03d93"><span class="section-number-2">2.</span> Overview</h2>
 <div class="outline-text-2" id="text-2">
 <ul class="org-ul">
-<li>See also: <a href="https://www3.svjatoslav.eu/projects/svjatoslav_commons/apidocs/">CLI Helper JavaDoc</a>.</li>
+<li>See also: <a href="https://www3.svjatoslav.eu/projects/cli-helper/apidocs/">CLI Helper JavaDoc</a></li>
 </ul>
 
 <p>
-This library is a collection of command-line interface (CLI) helper
-functions that simplifies the process of building and maintaining CLI
-applications. The library provides several different functionalities,
-such as:
+This is library intended to facilitate creation of commandline
+applications in Java programming language. Library is packaged as an
+artifact to Maven repository. This makes it simple to add library as
+dependency to your project.
 </p>
 
+<p>
+Library provides following general functionalities:
+</p>
 <ul class="org-ul">
-<li><a href="#org7e47dc1">Asking for user input</a></li>
-<li><a href="CLI arguments processing.html#ID-46115263-ed3d-4acc-9ec5-523d7acf87b8">Commandline interface arguments processing</a></li>
+<li><a href="#orgbe808ef">Asking for user input</a></li>
+<li><a href="CLI arguments processing.html#ID-46115263-ed3d-4acc-9ec5-523d7acf87b8">Commandline arguments processing</a></li>
 </ul>
 </div>
 
-<div id="outline-container-org7e47dc1" class="outline-3">
-<h3 id="org7e47dc1"><span class="section-number-3">2.1.</span> Ask for user input</h3>
+<div id="outline-container-orgbe808ef" class="outline-3">
+<h3 id="orgbe808ef"><span class="section-number-3">2.1.</span> Ask for user input</h3>
 <div class="outline-text-3" id="text-2-1">
 <dl class="org-dl">
 <dt>askBoolean()</dt><dd>Asks the user to enter a boolean value (yes/no).</dd>
@@ -288,9 +293,18 @@ such as:
 </div>
 </div>
 
-<div id="outline-container-orge7ef3ef" class="outline-2">
-<h2 id="orge7ef3ef"><span class="section-number-2">3.</span> Getting the library</h2>
+<div id="outline-container-org20035ac" class="outline-2">
+<h2 id="org20035ac"><span class="section-number-2">3.</span> Alternatives and further reading</h2>
 <div class="outline-text-2" id="text-3">
+<ul class="org-ul">
+<li><a href="https://clig.dev/">Command Line Interface Guidelines</a></li>
+</ul>
+</div>
+</div>
+
+<div id="outline-container-org2e7a568" class="outline-2">
+<h2 id="org2e7a568"><span class="section-number-2">4.</span> Getting the library</h2>
+<div class="outline-text-2" id="text-4">
 <p>
 Instructions to embed svjatoslav-commons library in your project:
 </p>
@@ -305,7 +319,7 @@ Maven pom.xml file snippet:
     &lt;<span style="color: #89b4fa;">dependency</span>&gt;
         &lt;<span style="color: #89b4fa;">groupId</span>&gt;eu.svjatoslav&lt;/<span style="color: #89b4fa;">groupId</span>&gt;
         &lt;<span style="color: #89b4fa;">artifactId</span>&gt;cli-helper&lt;/<span style="color: #89b4fa;">artifactId</span>&gt;
-        &lt;<span style="color: #89b4fa;">version</span>&gt;1.0&lt;/<span style="color: #89b4fa;">version</span>&gt;
+        &lt;<span style="color: #89b4fa;">version</span>&gt;1.2&lt;/<span style="color: #89b4fa;">version</span>&gt;
     &lt;/<span style="color: #89b4fa;">dependency</span>&gt;
     ...
 &lt;/<span style="color: #89b4fa;">dependencies</span>&gt;
@@ -324,10 +338,39 @@ Maven pom.xml file snippet:
 </div>
 </div>
 </div>
+<div id="outline-container-orgcc45c0c" class="outline-2">
+<h2 id="orgcc45c0c"><span class="section-number-2">5.</span> TODO:</h2>
+<div class="outline-text-2" id="text-5">
+<p>
+List of improvement suggestions:
+</p>
+
+<ul class="org-ul">
+<li>Add more concrete examples of how to use the library in JavaDoc
+comments. This will help developers quickly get started and learn
+the API.</li>
+
+<li>Provide more comprehensive unit tests for CliHelper,
+ParameterParser, Options and subclasses. This will ensure robustness
+and stability.</li>
+
+<li>Add JavaDoc comments to all classes and methods where
+applicable. This will provide better visibility into the library's
+functionality for developers.</li>
+
+<li>Add more option types like date/time, regular expression etc.</li>
+
+<li>Document best practices for using the library in a larger project.</li>
+
+<li>Implement support for more complex CLI applications like option
+dependencies and conflicts resolution.</li>
+</ul>
+</div>
+</div>
 </div>
 <div id="postamble" class="status">
 <p class="author">Author: Svjatoslav Agejenko</p>
-<p class="date">Created: 2023-10-12 Thu 22:18</p>
+<p class="date">Created: 2024-04-25 Thu 17:30</p>
 <p class="validation"><a href="https://validator.w3.org/check?uri=referer">Validate</a></p>
 </div>
 </body>
