Skip to content

Commit 3f20465

Browse files
committed
update documentation and changes.md
1 parent 1f7a68a commit 3f20465

File tree

2 files changed

+13
-9
lines changed

2 files changed

+13
-9
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ non-options do not stop option parsing, so options and non-options can be in any
1111
### What sets it apart
1212

1313
* No reflection, purely static analysis.
14-
* No runtime dependency. The generated `*Parser.java` is self-contained.
14+
* No runtime dependency. The generated `*_Parser.java` is self-contained.
1515
* Convenient, flexible property binding via constructor.
1616
* Deliberately simple: `String` and `boolean` only.
1717
No <em>converters</em>, no <em>default values</em>, no <em>required</em>.
@@ -82,24 +82,24 @@ final class Curl {
8282
````
8383

8484
* `@CommandLineArguments` triggers the code generation. The generated code requires Java 8.
85-
* Class `CurlParser` will be generated in the same package.
85+
* Class `Curl_Parser` will be generated in the same package.
8686

87-
`CurlParser` has only one method, but there's also an `enum` to consider.
87+
`Curl_Parser` has only one method, but there's also an `enum` to consider.
8888

89-
* The generated enum `CurlParser.Option` has constants `HEADERS`, `VERBOSE`, `METHOD` and `URLS`.
89+
* The generated enum `Curl_Parser.Option` has constants `HEADERS`, `VERBOSE`, `METHOD` and `URLS`.
9090
These correspond to the constructor arguments, and have methods to <b>generate usage text</b>.
91-
* The generated static method `CurlParser.parse(String[] args)`
91+
* The generated static method `Curl_Parser.parse(String[] args)`
9292
takes the `args` argument from `public static void main(String[] args)`.
93-
* `parse` returns another generated class, `CurlParser.Binder`.
93+
* `parse` returns another generated class, `Curl_Parser.Binder`.
9494
* `parse` will throw `IllegalArgumentException` if it cannot make sense of the input.
9595

96-
The generated class `CurlParser.Binder` has two methods:
96+
The generated class `Curl_Parser.Binder` has two methods:
9797

9898
* `binder.bind()` invokes the constructor. It returns a `Curl` instance.
9999
* `binder.otherTokens()` returns a `List<String>`. Unless `@OtherTokens` are already used in your constructor,
100100
should be inspected before invoking `bind()`, to inform the user about a possible input error.
101101

102-
Let's see how `CurlParser.parse(String[] args)` handles some good old input.
102+
Let's see how `Curl_Parser.parse(String[] args)` handles some good old input.
103103
For example, if `args` is
104104

105105
* `{--method, --method}`, then `method` will be the string `--method`.
@@ -149,7 +149,7 @@ If you're not familiar with `rm`'s `--` option, try `echo >>-f` and deleting the
149149
<dependency>
150150
<groupId>com.github.h908714124</groupId>
151151
<artifactId>jbock</artifactId>
152-
<version>1.5</version>
152+
<version>1.6</version>
153153
<scope>provided</scope>
154154
</dependency>
155155
````

changes.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,3 +71,7 @@
7171
* improved formatting of gen code
7272
* renamed local variables in gen code
7373
* generate more javadoc
74+
75+
### 2017-04-29 jBock 1.6 released
76+
77+
* add an underscore to gen class name, to make clear it's generated

0 commit comments

Comments
 (0)