From e8f029969d48634280dc5ad9d9c43ba4c0699cd9 Mon Sep 17 00:00:00 2001 From: Svjatoslav Agejenko Date: Mon, 23 Oct 2023 00:24:16 +0300 Subject: [PATCH] Update documentation for enhanced clarity Improved the content and organization of the CLI Helper documentation. Changes include finer details about the functionalities, easier organization, and addition of a 'TODO' section for continuous improvement. This aims to facilitate user understanding and quick start with the library. --- doc/index.html | 79 +++++++++++++++++++++++++++++++++++--------------- doc/index.org | 35 ++++++++++++++++++---- 2 files changed, 85 insertions(+), 29 deletions(-) diff --git a/doc/index.html b/doc/index.html index 4648538..9ff3194 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,23 +202,24 @@

Table of Contents

-
-

1. General

+
+

1. General

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

1.1. Source code

+
+

1.1. Source code

-
-

2. Library contents

+
+

2. Overview

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

+

+Library provides following general functionalities: +

-
-

2.1. Ask for user input

+
+

2.1. Ask for user input

askBoolean()
Asks the user to enter a boolean value (yes/no).
@@ -288,8 +292,8 @@ such as:
-
-

3. Getting the library

+
+

3. Getting the library

Instructions to embed svjatoslav-commons library in your project: @@ -324,10 +328,39 @@ Maven pom.xml file snippet:

+
+

4. 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: 2023-10-12 Thu 22:18

+

Created: 2023-10-23 Mon 00:22

Validate

diff --git a/doc/index.org b/doc/index.org index dde84b2..6ed2f6e 100644 --- a/doc/index.org +++ b/doc/index.org @@ -24,19 +24,20 @@ - See [[https://www3.svjatoslav.eu/projects/cli-helper/apidocs/][JavaDoc]] -* Library contents +* Overview :PROPERTIES: :ID: fef7ebc3-0f00-4b82-a926-c0cfdf709762 :END: - See also: [[https://www3.svjatoslav.eu/projects/svjatoslav_commons/apidocs/][CLI Helper JavaDoc]]. -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. +Library provides following general functionalities: - [[id:4fca35e4-fdf1-4675-a36f-6206d6fb72cb][Asking for user input]] -- [[id:46115263-ed3d-4acc-9ec5-523d7acf87b8][Commandline interface arguments processing]] +- [[id:46115263-ed3d-4acc-9ec5-523d7acf87b8][Commandline arguments processing]] ** Ask for user input :PROPERTIES: @@ -74,3 +75,25 @@ Maven pom.xml file snippet: ... #+END_SRC +* 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. -- 2.20.1