X-Git-Url: http://www2.svjatoslav.eu/gitweb/?a=blobdiff_plain;f=doc%2Findex.html;h=fc778b54184b215cd8120dcc38d555460942858f;hb=HEAD;hp=cf028f3b36c17c48e2aa45a4ffd6828ed969f73c;hpb=1a99cede0c73a8c7c1cb9b2c611d920b0667e0aa;p=cli-helper.git diff --git a/doc/index.html b/doc/index.html index cf028f3..fc778b5 100644 --- a/doc/index.html +++ b/doc/index.html @@ -3,7 +3,7 @@ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - + CLI Helper - library to help implementing commandline interfaces @@ -202,19 +202,25 @@

Table of Contents

-
-

1. General

+
+

1. General

  • This program is free software: released under Creative Commons Zero @@ -231,8 +237,8 @@
-
-

1.1. Source code

+
+

1.1. Source code

  • Download latest snapshot in TAR GZ format
    • @@ -243,7 +249,7 @@ Clone Git repository using command: 

    -git clone https://www2.svjatoslav.eu/git/cli-helper.git
+git clone https://www3.svjatoslav.eu/git/cli-helper.git
  • See JavaDoc
    • @@ -252,34 +258,55 @@ git clone https://www2.svjatoslav.eu/git/cli-helper.git
-
-

2. Library contents

+
+

2. Overview

-

  • -Commandline Interface helper +

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

    -
    -eu.svjatoslav.commons.cli_helper.CLIHelper
-
    • -

  • -Commandline arguments parser and validator. +

    +Library provides following general functionalities:

    -
    -eu.svjatoslav.commons.cli_helper.parameter_parser
-
    • +
    + +
    +

    2.1. Ask for user input

    +
    +
    +
    askBoolean()
    Asks the user to enter a boolean value (yes/no).
    +
    askLong()
    Asks the user to enter an integer.
    +
    askString()
    Asks the user to enter a string.
    +
    +
    +
    -
    -

    3. Usage

    +
    +

    3. Alternatives and further reading

    + +
    +
    + +
    +

    4. Getting the library

    +

    -Instructions to embed svjatoslav-commons in your project as a library: +Instructions to embed svjatoslav-commons library in your project:

    @@ -287,34 +314,63 @@ Maven pom.xml file snippet:

    -
    <dependencies>
+
    <dependencies>
     ...
-    <dependency>
-        <groupId>eu.svjatoslav</groupId>
-        <artifactId>cli-helper</artifactId>
-        <version>1.0</version>
-    </dependency>
+    <dependency>
+        <groupId>eu.svjatoslav</groupId>
+        <artifactId>cli-helper</artifactId>
+        <version>1.2</version>
+    </dependency>
     ...
-</dependencies>
+</dependencies>
 
 
-<repositories>
+<repositories>
     ...
-    <repository>
-        <id>svjatoslav.eu</id>
-        <name>Svjatoslav repository</name>
-        <url>http://www3.svjatoslav.eu/maven/</url>
-    </repository>
+    <repository>
+        <id>svjatoslav.eu</id>
+        <name>Svjatoslav repository</name>
+        <url>http://www3.svjatoslav.eu/maven/</url>
+    </repository>
     ...
-</repositories>
+</repositories>
    +
    +

    5. TODO:

    +
    +

    +List of improvement suggestions: +

    + +
      +
    • Add more concrete examples of how to use the library in JavaDoc +comments. This will help developers quickly get started and learn +the API.
      • + +
    • Provide more comprehensive unit tests for CliHelper, +ParameterParser, Options and subclasses. This will ensure robustness +and stability.
      • + +
    • Add JavaDoc comments to all classes and methods where +applicable. This will provide better visibility into the library's +functionality for developers.
      • + +
    • Add more option types like date/time, regular expression etc.
      • + +
    • Document best practices for using the library in a larger project.
      • + +
    • Implement support for more complex CLI applications like option +dependencies and conflicts resolution.
      • +
    +
    +

    Author: Svjatoslav Agejenko

    -

    Created: 2022-07-13 Wed 04:24

    +

    Created: 2024-04-25 Thu 17:30

    Validate