- 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:
...
</repositories>
#+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.
projects / cli-helper.git / blobdiff