Skip to content

Commit 476368d

Browse files
authored
Update README.md (#36)
1 parent 2e15773 commit 476368d

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,11 @@ so it doesn't use runtime reflection, but generates a custom parser at compile t
1111

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

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

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

0 commit comments

Comments
 (0)