projects / cli-helper.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Update naming in commandline parser
[cli-helper.git] / doc / index.html
diff --git a/doc/index.html b/doc/index.html
index cf028f3..4648538 100644 (file)
--- 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>
-<!-- 2022-07-13 Wed 04:24 -->
+<!-- 2023-10-12 Thu 22:18 -->
 <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,19 +202,23 @@
 <h2>Table of Contents</h2>
 <div id="text-table-of-contents" role="doc-toc">
 <ul>
-<li><a href="#org5be2417">1. General</a>
+<li><a href="#orgf8634f9">1. General</a>
 <ul>
-<li><a href="#org3a8d88b">1.1. Source code</a></li>
+<li><a href="#orgd17f1cf">1.1. Source code</a></li>
 </ul>
 </li>
-<li><a href="#org8bb96fe">2. Library contents</a></li>
-<li><a href="#org93b7ead">3. Usage</a></li>
+<li><a href="#org873ac39">2. Library contents</a>
+<ul>
+<li><a href="#org7e47dc1">2.1. Ask for user input</a></li>
+</ul>
+</li>
+<li><a href="#orge7ef3ef">3. Getting the library</a></li>
 </ul>
 </div>
 </div>
 
-<div id="outline-container-org5be2417" class="outline-2">
-<h2 id="org5be2417"><span class="section-number-2">1.</span> General</h2>
+<div id="outline-container-orgf8634f9" class="outline-2">
+<h2 id="orgf8634f9"><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
@@ -231,8 +235,8 @@
 </ul>
 </div>
 
-<div id="outline-container-org3a8d88b" class="outline-3">
-<h3 id="org3a8d88b"><span class="section-number-3">1.1.</span> Source code</h3>
+<div id="outline-container-orgd17f1cf" class="outline-3">
+<h3 id="orgd17f1cf"><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>
@@ -252,34 +256,43 @@ git clone https://www2.svjatoslav.eu/git/cli-helper.git
 </div>
 </div>
 
-<div id="outline-container-org8bb96fe" class="outline-2">
-<h2 id="org8bb96fe"><span class="section-number-2">2.</span> Library contents</h2>
+<div id="outline-container-org873ac39" class="outline-2">
+<h2 id="org873ac39"><span class="section-number-2">2.</span> Library contents</h2>
 <div class="outline-text-2" id="text-2">
 <ul class="org-ul">
-<li>See <a href="https://www3.svjatoslav.eu/projects/svjatoslav_commons/apidocs/">JavaDoc</a>.</li>
+<li>See also: <a href="https://www3.svjatoslav.eu/projects/svjatoslav_commons/apidocs/">CLI Helper JavaDoc</a>.</li>
+</ul>
 
-<li><p>
-Commandline Interface helper
+<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:
 </p>
-<pre class="example">
-eu.svjatoslav.commons.cli_helper.CLIHelper
-</pre></li>
 
-<li><p>
-Commandline arguments parser and validator.
-</p>
-<pre class="example">
-eu.svjatoslav.commons.cli_helper.parameter_parser
-</pre></li>
+<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>
 </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 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>
+<dt>askLong()</dt><dd>Asks the user to enter an integer.</dd>
+<dt>askString()</dt><dd>Asks the user to enter a string.</dd>
+</dl>
+</div>
+</div>
 </div>
 
-<div id="outline-container-org93b7ead" class="outline-2">
-<h2 id="org93b7ead"><span class="section-number-2">3.</span> Usage</h2>
+<div id="outline-container-orge7ef3ef" class="outline-2">
+<h2 id="orge7ef3ef"><span class="section-number-2">3.</span> Getting the library</h2>
 <div class="outline-text-2" id="text-3">
 <p>
-Instructions to embed svjatoslav-commons in your project as a library:
+Instructions to embed svjatoslav-commons library in your project:
 </p>
 
 <p>
@@ -287,26 +300,26 @@ Maven pom.xml file snippet:
 </p>
 
 <div class="org-src-container">
-<pre class="src src-xml">&lt;<span style="color: #A6E22E;">dependencies</span>&gt;
+<pre class="src src-xml">&lt;<span style="color: #89b4fa;">dependencies</span>&gt;
     ...
-    &lt;<span style="color: #A6E22E;">dependency</span>&gt;
-        &lt;<span style="color: #A6E22E;">groupId</span>&gt;eu.svjatoslav&lt;/<span style="color: #A6E22E;">groupId</span>&gt;
-        &lt;<span style="color: #A6E22E;">artifactId</span>&gt;cli-helper&lt;/<span style="color: #A6E22E;">artifactId</span>&gt;
-        &lt;<span style="color: #A6E22E;">version</span>&gt;1.0&lt;/<span style="color: #A6E22E;">version</span>&gt;
-    &lt;/<span style="color: #A6E22E;">dependency</span>&gt;
+    &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;">dependency</span>&gt;
     ...
-&lt;/<span style="color: #A6E22E;">dependencies</span>&gt;
+&lt;/<span style="color: #89b4fa;">dependencies</span>&gt;
 
 
-&lt;<span style="color: #A6E22E;">repositories</span>&gt;
+&lt;<span style="color: #89b4fa;">repositories</span>&gt;
     ...
-    &lt;<span style="color: #A6E22E;">repository</span>&gt;
-        &lt;<span style="color: #A6E22E;">id</span>&gt;svjatoslav.eu&lt;/<span style="color: #A6E22E;">id</span>&gt;
-        &lt;<span style="color: #A6E22E;">name</span>&gt;Svjatoslav repository&lt;/<span style="color: #A6E22E;">name</span>&gt;
-        &lt;<span style="color: #A6E22E;">url</span>&gt;http://www3.svjatoslav.eu/maven/&lt;/<span style="color: #A6E22E;">url</span>&gt;
-    &lt;/<span style="color: #A6E22E;">repository</span>&gt;
+    &lt;<span style="color: #89b4fa;">repository</span>&gt;
+        &lt;<span style="color: #89b4fa;">id</span>&gt;svjatoslav.eu&lt;/<span style="color: #89b4fa;">id</span>&gt;
+        &lt;<span style="color: #89b4fa;">name</span>&gt;Svjatoslav repository&lt;/<span style="color: #89b4fa;">name</span>&gt;
+        &lt;<span style="color: #89b4fa;">url</span>&gt;http://www3.svjatoslav.eu/maven/&lt;/<span style="color: #89b4fa;">url</span>&gt;
+    &lt;/<span style="color: #89b4fa;">repository</span>&gt;
     ...
-&lt;/<span style="color: #A6E22E;">repositories</span>&gt;
+&lt;/<span style="color: #89b4fa;">repositories</span>&gt;
 </pre>
 </div>
 </div>
@@ -314,7 +327,7 @@ Maven pom.xml file snippet:
 </div>
 <div id="postamble" class="status">
 <p class="author">Author: Svjatoslav Agejenko</p>
-<p class="date">Created: 2022-07-13 Wed 04:24</p>
+<p class="date">Created: 2023-10-12 Thu 22:18</p>
 <p class="validation"><a href="https://validator.w3.org/check?uri=referer">Validate</a></p>
 </div>
 </body>
Unnamed repository; edit this file 'description' to name the repository.