Skip to content

Commit e44a2d0

Browse files
author
Leonhard Bromoloron
committed
update documentation
1 parent 6b7c01c commit e44a2d0

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
@@ -8,7 +8,7 @@ It is an
88
[annotation processor](https://openjdk.java.net/groups/compiler/processing-code.html)
99
which does not use runtime reflection, but generates a custom parser at compile time instead.
1010

11-
### Quick rundown
11+
### Quick start
1212

1313
Choose any name for the java interface which will describe your command line API.
1414
Add the `@Command` anntation to your command interface, to make the annotation processor aware of it.
@@ -23,9 +23,9 @@ The return types `boolean`, `List<?>` and `Optional<?>` (including `OptionalInt`
2323
They are used to declare flags, repeable and optional options and parameters, respectively.
2424

2525
> [!TIP]
26-
> If a method is annotated with `@VarargsParameter`, it must return a list.
27-
> There cannot be more than one such method.
28-
> If no attributes are specified, the `@VarargsParameter` annotation can be omitted.
26+
> If an abstract method is annotated with `@VarargsParameter`, it must return a list.
27+
> There must not be more than one such method.
28+
> The varargs annotation can also be omitted, unless you want to override attributes.
2929
3030
Here's an example:
3131

0 commit comments

Comments
 (0)