docs: add comprehensive usage examples to cli-helper classes
authorSvjatoslav Agejenko <svjatoslav@svjatoslav.eu>
Wed, 18 Mar 2026 20:42:06 +0000 (22:42 +0200)
committerSvjatoslav Agejenko <svjatoslav@svjatoslav.eu>
Wed, 18 Mar 2026 20:42:06 +0000 (22:42 +0200)
commit5a77c788dfefc6ebdefd44d860844b88cd3ffc79
tree85353b07391baf018688e7178e77b6e05ffdeb69
parent1ddcb1d96d791fc81741f8ea7f6d0ed503a723c2
docs: add comprehensive usage examples to cli-helper classes

Add Javadoc examples to CLIHelper, Menu, Parser, and all option types (FileOption, StringOption, IntegerOption, etc.). Include code samples showing fluent API usage, command-line invocation examples, and error handling scenarios. Fix HTML formatting issues (misplaced </p> tags).
15 files changed:
src/main/java/eu/svjatoslav/commons/cli_helper/CLIHelper.java
src/main/java/eu/svjatoslav/commons/cli_helper/Menu.java
src/main/java/eu/svjatoslav/commons/cli_helper/parameter_parser/Option.java
src/main/java/eu/svjatoslav/commons/cli_helper/parameter_parser/ParameterCount.java
src/main/java/eu/svjatoslav/commons/cli_helper/parameter_parser/Parser.java
src/main/java/eu/svjatoslav/commons/cli_helper/parameter_parser/parameter/DirectoryOption.java
src/main/java/eu/svjatoslav/commons/cli_helper/parameter_parser/parameter/DirectoryOptions.java
src/main/java/eu/svjatoslav/commons/cli_helper/parameter_parser/parameter/ExistenceType.java
src/main/java/eu/svjatoslav/commons/cli_helper/parameter_parser/parameter/FileOption.java
src/main/java/eu/svjatoslav/commons/cli_helper/parameter_parser/parameter/FileOptions.java
src/main/java/eu/svjatoslav/commons/cli_helper/parameter_parser/parameter/FloatOption.java
src/main/java/eu/svjatoslav/commons/cli_helper/parameter_parser/parameter/IntegerOption.java
src/main/java/eu/svjatoslav/commons/cli_helper/parameter_parser/parameter/NullOption.java
src/main/java/eu/svjatoslav/commons/cli_helper/parameter_parser/parameter/StringOption.java
src/main/java/eu/svjatoslav/commons/cli_helper/parameter_parser/parameter/StringOptions.java