Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #36

Merged
merged 1 commit into from
Mar 5, 2024
Merged

Update README.md #36

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,11 @@ so it doesn't use runtime reflection, but generates a custom parser at compile t

Create an abstract class, or alternatively a Java interface,
and add the `@Command` annotation.
In this so-called *command class*, each abstract method
In this so-called *command class*, each abstract method represents a command line option or argument.
Every such method must have

* must return *something* (not `void`),
* must have *no* arguments, and
* must be annotated with either `@Option`, `@Parameter` or `@VarargsParameter`.
* getter signature (doesn't return `void`, takes no arguments) and
* annotation (either `@Option`, `@Parameter` or `@VarargsParameter`).

The *multiplicity* of options and parameters is determined by the *return type* of their declaring method.
The types `boolean`, `List` and `Optional` (including `OptionalInt`, yada yada) have a special meaning.
Expand Down
Loading